Sgmltexi
An alternative way to write Texinfo documentation
This edition is for Sgmltexi 2003.03.30 for Texinfo 4
Daniele Giacomini <daniele@swlibero.org>
Copyright © 2000-2003 Daniele Giacomini <daniele@swlibero.org>
Permission is granted to copy, distribute and/or modify this document under the terms of
the GNU Free Documentation License, Version 1.1 or any later version published by the
Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with
no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free
Documentation License".
Short Contents
Introduction to Sgmltexi 1
1 General structure for a Sgmltexi source file 2
2 Sectioning, nodes and menus 14
3 Block and in-line 17
4 Index and cross reference 18
5 Marking words and phrases 20
6 Marking block of text 21
7 List and tables 23
8 Insertions 25
9 Definitions 26
10 Conditional and literal back-end code 29
11 How to use the front-end 33
12 How to install 35
13 Dependencies 36
14 Encoding 37
15 Supported and unsupported Texinfo feature 38
A Supported ISOnum entities: numeric and special graphic ... 61
B Supported ISOpub entities: publishing 63
C Supported ISOtech entities: general technical 65
D Supported ISOlatl entities: added latin 1 67
E Supported IS01at2 entities: added latin 2 69
GNU Free Documentation License 72
Index 78
Introduction to Sgmltexi
1
Introduction to Sgmltexi
Sgmltexi is a DTD with tools to get Texinfo. The idea is to have another way to write
Texinfo documents, intended to be a little bit easier, but also with some limitations.
Sgmltexi manages Texinfo nodes automatically, generating a an Info menu at the Top
node, and other menus if required. The node names may be generated automatically with
string like "chap 1", "app A" and so on, or can be inserted manually, with different names.
The Sgmltexi document has a precise scheme: there may be one or more introductions,
there is a body (made probably of chapters), there may be appendixes and indexes. The
body is organized into chapters, that may be grouped into parts and also tomes. This way,
also big documents are easily managed.
Sgmltexi is a work derived form ALtools and Alml, from the same author. These are
the SGML typesetting systems made for the need of an Italian documentation project:
Appunti di informatica libera.
Obtain Sgmltexi
At the moment, the main distribution source for Sgmltexi is the following URI:
http : / /a2 . swlibero . org/~daniele/sof tware/ sgmltexi/
What's new about Sgmltexi
The new Sgmltexi is simplified: the derivation system was removed, and the Sgmltexi
source files should be "expanded" to avoid the horizontal tabs presence. The expansion is
needed when reproducing literal text, otherwise, strings like '\011' will appear, instead of
original tabs.
This modification will reduce the pre-elaboration time, and will avoid also some possible
troubles with SGML files included inside the main source.
C \
Please consider that this one might be the last release for Sgmltexi, because the Texinfo
development is taking different SGML /XML paths.
I J
Chapter 1: General structure for a Sgmltexi source file
2
1 General structure for a Sgmltexi source file
The typical Sgmltexi source start like this:
<!D0CTYPE Sgmltexi PUBLIC "-//GNU//DTD Sgmltexi//EN">
It can be useful to define also some internal entities, like this:
<!D0CTYPE Sgmltexi PUBLIC "-//GNU//DTD Sgmltexi//EN"
[
<! ENTITY EDITION "2003.10.11" >
]>
All the document is enclosed inside the element sgmltexi. Inside, there must be an
head element, there may be an intro element, there must be a body element, and there
may be an appendix element. The space after the appendix element may be occupied by
some indexes (will be shown later).
<sgmltexi>
<head>
</head>
<intro>
</ intro>
<body>
</body>
<appendix>
</appendix>
</ sgmltexi>
The element sgmltexi has three possible attribute: lang, charset and spacing.
lang [Attribute]
This is a two letter code defining the text language. The use of this attribute generates
a Odocumentlanguage command.
charset [Attribute]
This is the input character set, like it can be done with the Texinfo
Odocumentencoding command. It is obscured by the ' — input-encoding' option,
that take precedence and generate a pure ISO 646 Texinfo output.
spacing [Attribute]
This is a deprecated feature that help controlling the spacing after sentences. It
is deprecated because this action should be controlled with the language specific
configuration. This attribute is here only as a last resort. Valid values are: normal,
french and uniform. Selecting french or uniform it is introduced the command
@f renchspacing.
Chapter 1: General structure for a Sgmltexi source file
3
<sgmltexi lang="it" charset="IS0-8859-l" spacing="unif orm">
1.1 head
The head element is the more complicated. It is important to define many informations
about the document. Here it is the example from this manual:
<head>
<admin>
<setf ilename content=" sgmltexi . inf o">
<settitle content=" Sgmltexi ">
<set chapternewpage content= " odd" >
<def index name="sg">
<syncodeindex from="sg" to="cp">
<syncodeindex from="vr" to="cp">
<infodir cat="Texinfo documentation system">
</admin>
<titlepage>
<title>Sgmltexi</title>
<subtitle>An alternative way to write Texinfo
document at ion</ subtitle>
<subtitle>This edition is for Sgmltexi
&EDITI0N; for Texinfo 4</subtitle>
<abstract>
<p>Sgmltexi is an SGML system (DTD and tools) to
make Texinfo documentation using SGML. . .</p>
</abstract>
<author>Daniele Giacomini
felt ; daniele@swlibero . org> ; </ author>
<legal>
<copyright>Copyright fecopy; 2000-2003 Daniele Giacomini
felt ; danieleOswlibero . org> ; </copyright>
<publishnote>
<p>Published by. . .</p>
</publishnote>
<license>
<p>Permission is granted to make and distribute
verbatim copies of this manual ... </p>
</license>
<coverart>
<p>Cover art by ...</p>
</ coverart>
</legal>
</titlepage>
<shortcontents>
Chapter 1: General structure for a Sgmltexi source file
4
<contents>
</head>
This is not all necessary, but it is a good starting point. Looking at this example,
can be recognized some important elements: admin, for administrative informations, and
titlepage.
1.2 admin
The admin element is used to enclose some empty elements that describe informations
that should go inside the Texinfo header. The order for these elements is not important,
as Texinfo source will be build in the right one. It follows a summary table and then the
detailed description.
Attribute
content
Element
setfilename
settitle
content
setchapternewpage
content
footnotestyle
headings
defindex
defcodeindex
synindex
syncodeindex
infodir
content
content
name
name
from
to
from
to
cat
Content
empty
empty
empty
on, off, odd
empty
end, separate
empty
on, off,
single, double,
singleafter,
doubleafter
empty
empty
empty
empty
empty or literal
©direntry
Description or Texinfo equivalence
©setfilename
Info file name
©settitle
title
©setchapternewpage
tell how to separate chapters
©footnotestyle
where to place footnotes
©headings
how headings should work
©defindex
define a two letter index name
©defcodeindex
define a two letter index name with ©code
items
©synindex
source index, as a two letters name
destination index, as a two letters name
©syncodeindex
source index, as a two letters name
destination index, with ©code items
Info directory information
The ©dircategory argument
setfilename [Element]
This element is empty and is used to define the file name for Info, with the Texinfo
command ©setfilename.
Chapter 1: General structure for a Sgmltexi source file
5
content [Attribute]
This attribute is used to assign the file name.
Use this element like this, only with the opening tag:
<setf ilename content=" sgmltexi . inf o">
settitle [Element]
This element is empty and is used to define the title for Info, with the Texinfo com-
mand @settitle.
content [Attribute]
This attribute is used to assign the title.
Use this element like this, only with the opening tag:
<settitle content=" Sgmltexi ">
setchapternewpage [Element]
This element is empty and is used to define the Texinfo command
©setchapternewpage.
content [Attribute]
This attribute is used to assign the desired value, that can be: on, off or odd.
Use this element like this, only with the opening tag:
<setchapternewpage content="on">
This element is not essential.
footnotestyle [Element]
This element is empty and is used to define the Texinfo command ©footnotestyle.
content [Attribute]
This attribute is used to assign the desired value, that can be: end or separate.
Use this element like this, only with the opening tag:
<f ootnotestyle content="end">
This element is not essential.
heading [Element]
This element is empty and is used to define the Texinfo command Sheadings.
content [Attribute]
This attribute is used to assign the desired value, that can be: on, off, single,
double, singleafter, doubleafter.
Use this element like this, only with the opening tag:
<headings content="double">
This element is not essential.
Chapter 1: General structure for a Sgmltexi source file
6
defindex [Element]
defcodeindex [Element]
These two empty elements are used to define the Texinfo commands @def index and
@def codeindex.
name [Attribute]
This attribute is used to define the name of the new user index that is to be
created. The name must be a two letter word.
Use these elements like this, only with the opening tag:
<defindex name="sg">
<def codeindex name="xx">
These elements are used only as needed, for as many user defined index that are to
be created.
synindex [Element]
syncodeindex [Element]
These two elements are used to copy one index into another, like the command
©synindex and ©syncodeindex do with Texinfo.
from [Attribute]
to [Attribute]
The first attribute is used to define the index to copy; the second is the index
that receive the first one.
Use this element like this, only with the opening tag:
<syncodeindex from="fn" to="cp">
This element is used only as needed, for as many user defined index that are to be
created.
infodir [Element]
This element is used to define the Info directory menu item, when the file is installed
with install-inf o.
cat [Attribute]
This attribute defines the category, like the Texinfo command @dircategory
does.
This element can be used empty, like this:
<infodir cat="Texinfo documentation system">
But this element can be used also more explicitly, like this:
<infodir cat="Texinfo documentation system">
* Sgmltexi: (sgmltexi). SGML for Texinfo.
* Sgmltexi install: (sgmltexi) install . Install Sgmltexi.
</ inf odir>
This element is used only if needed. If the element is use empty, only one line inside
the @direntry environment is inserted, with information already given.
Chapter 1: General structure for a Sgmltexi source file
7
1.3 titlepage
The titlepage element is used to enclose all informations that go on the first pages of
the document. The order of elements is important. It follows a summary table and then
the detailed description.
Element Attribute
Content
Description or Texinfo equivalence
title
in-line
©title
subtitle
m-hne
©subtitle
abstract
block
abstract of the document
author
in-line
©author
frn n t povptI" py t
t p"vt t; n mum on t np r\v\ n t pm rrrvnf' povpt
LCA b QllVJ W 11 \JL1 L11C M-L 111UCLI 11 Ull b K^\J V CI
tpextra
block
extra text shown inside title pages
legal
copyright,
publishnote,
license,
legal information
legal
coverart
block
simplified legal information
copyright
One copyright owner
publishnote
block
publishing note that should appear before
license
block
the license
license or reference to the license, or other
coverart
block
conditions related to the document
coverart note that should appear after the
dedications
block
license
dedications for a book
title [Element]
This element contains the document title; the title for the "printed" document. It is
equivalent to ©title for Texinfo. Use this element like this:
<title>Sgmltexi</title>
subtitle [Element]
This element can be used to define one or more subtitles. It is equivalent to ©subtitle
for Texinfo. Use this element like this, after the title:
<subtitle>An alternative way to write Texinfo documentation</subtitle>
This element is used only as needed, without limitations.
abstract [Element]
This element can be used to define a brief description for the document. The content
must be block text, like the element p. This text is used for Info typesetting, inside
the Top node. Use this element like this:
<abstract>
<p>Sgmltexi is an SGML system (DTD and tools) to
make Texinfo documentation using SGML.
The Sgmltexi DTD is designed to...</p>
Chapter 1: General structure for a Sgmltexi source file
8
<p>. . .</p>
</abstract>
This element can be used at most one time.
author [Element]
This element can be used to define one of the document authors. This element is
equivalent to the Texinfo command ©author. Use this element like this:
<author>Tizio Tizi <tizio@dinkel.brot.dg></author>
<author>Caio Cai felt ; caio@dinkel .brot . dg> ; </author>
This element must be used at least one time.
frontcovertext [Element]
This element can be used to include one or more block of text, that should appear on
the front cover, for the printed edition. Use this element like this:
<f ront covert ext>
<p>Version 1.2.3</p>
<p><image name=" good-thing" height="5cm"x/p>
</f rontcovertext>
tpextra [Element]
This element can be used to include one or more block of text, that should appear
on different places: before the legal informations; after legal information; after the
dedications. The name tpextra stand for "title page extra" text. Use this element
like this:
<tpextra>
<p><strong>Pinco Pallino</strong> is a very old man...</p>
<p><strong>Tizio Tizi</strong> studied telecommunication
technology. . .</p>
</tpextra>
<legal>
</legal>
<tpextra>
<p>The front cover picture is made by Sempronio . </p>
</tpextra>
Chapter 1: General structure for a Sgmltexi source file
9
<dedications>
< /dedi c at i ons >
<tpextra>
<p>The software is very important ; true free software is much more
important . </p>
</tpextra>
The use of this element is optional, but notice that the last one can be used only if
there is the dedications element before.
legal [Element]
This element is used to enclose other elements describing informations about copy-
right, license and publication.
copyright [Element]
This element contains a line of text describing the copyright owner for the
document.
publishnote [Element]
This optional element, contains block of text that show information about the
printed publication.
license [Element]
This element contains block of text to show the license conditions for the doc-
ument.
coverart [Element]
This optional element, contains block of text that show who is responsible for
the cover design.
Use this element like this:
<legal>
<copyright>Copyright © 2003 Free Software Foundation,
Inc . </ copyright>
<publishnote>
<p>Published by. . .</p>
</publishnote>
<license>
<p>Permission is granted to copy, distribute and/or
modify this document under the terms of the GNU Free
Documentation License, Version 1.1 or any later version
published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with
Chapter 1: General structure for a Sgmltexi source file
10
no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation
License" . </p>
</license>
<coverart>
<p>Cover art by . . . </p>
</coverart>
</legal>
This element must be used at least one time.
Actually, this element can have non special internal structure, enclosing simply other
block elements. This way, if the standard structure described above is not good for
the author intention, it may be used also like this:
<legal>
<p>Copyright fecopy; 2003 Free Software Foundation, Inc.</p>
<p>Published by. . .</p>
<p>Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections, with no Front-Cover Texts,
and with no Back-Cover Texts. A copy of the license is included in
the section entitled "GNU Free Documentation License" . </p>
<p>Cover art by . . .</p>
</legal>
dedications [Element]
This optional element, contains block of text that show one or more dedications.
1.4 Table of contents
After the titlepage, there is the place for one or more table of contents. To obtain the
insertion of these table of contents can be used one of the following empty element.
contents [Element]
The standard table of contents, like the command ©contents for Texinfo.
shortcontents [Element]
summarycontents [Element]
A reduced table of contents, like the command ©shortcontents and
©summarycontents for Texinfo.
Chapter 1: General structure for a Sgmltexi source file
11
1.5 menu
After the contents elements, may appear the menu element. This element ask explicitly
for the correspondent Texinfo @menu command. At this level, the menu is inserted auto-
matically, also without inserting this element. But the menu element may be used to define
a specific (manual) menu for texinfo. See the following example:
<menu>
Introduction
General structure for a Sgmltexi source file
How to use the front-end
How to install
GNU Free Documentation License
Index
</menu>
The menu may be used also at chapter level and below, and there can be also empty: in
this case, an automatic Texinfo menu will be inserted.
introduction
structure: :
how to use : :
install : :
GFDL : :
index: :
1.6 intro
After the head element there may be one intro element. This is just a way to define
a group of chapter that have no numbering. Chapters inside this element are delimited in
the same way as for the body and appendix elements.
<intro>
<hl>Introduction to Sgmltexi</hl>
<p>Sgmltexi is a DTD with tools to get Texinf o . . . </p>
<p>Sgmltexi manage Texinfo nodes automatically </p>
</ intro>
1.7 body
After the head and intro elements, there must be one body element. This is the body
of the document.
The body may be divided into chapters, or parts, or tomes, depending on the documen-
tation project that is started. Tomes are delimited with the element tomeheading, that
contains the tome title; parts are delimited using the element partheading, with the same
meaning.
Chapters and lower sectioning are a little anonymous, like HTML: hi, h2, h3 and h4.
This is done that way because introduction, body and appendix may have the same method
for text sectioning.
<body>
<partheader>Metworking</partheader>
Chapter 1: General structure for a Sgmltexi source file
12
<hl>IP protocol history</hl>
<p>Bla bla bla. . .</p>
<p>Bla bla bla. . .</p>
<h2>IS0/0SI model</h2>
<p>Bla bla bla. . .</p>
<p>Bla bla bla. . .</p>
<hl>IPv4 and IPv6</hl>
<p>Bla bla bla. . .</p>
<p> . . . </p>
</body>
Every sectioning element, from tome to last sub-subsection, have an optional attribute:
id. This attribute may be used to define an identification string that can be the target for
cross references.
<hl id="ip history">IP protocol history</hl>
Note that due to Texinfo design limitations, cross references labels cannot contain the
comma.
v '
1.8 appendix
After the body, it may be placed the appendix. This one is used to delimit a group of
chapters that must be intended as appendixes. This way, also the appendix is organized in
chapter delimited with hi heading, and smaller sections.
1.9 Indexes
After the body and after the optional appendix, can be placed one or more analytic
index. This is obtained with a special heading element: indexheading. This can be used
only in conjunction with printindex to define the type of index to include. The example
should be clear enough:
<indexheading>Index of functions</indexheading>
<printindex name="fn">
<indexheading>Concept index</ indexheading>
Chapter 1: General structure for a Sgmltexi source file
13
<print index name="cp">
</ sgmltexi>
As can be seen from the example, printindex has an attribute, name, that tells the type
of index to include. In fact, this way is generated the Texinfo command ©printindex.
Chapter 2: Sectioning, nodes and menus
14
2 Sectioning, nodes and menus
To write good documentation with Texinfo, it is required to have control on nodes
and menus. With Sgmltexi, nodes and menus can be forgotten, but the Info result may
suffer for this choice. Anyway, with Sgmltexi it is possible to choose different levels of
manual/automatic node handling.
Headings elements can incorporate some more attributes: node and menu. The first one
define the node name, overriding any automatic determination; the second define the node
description on the menu (the automatical choice is otherwise the title).
<hl id="ip history" node="history" menu="History of IP protocol">
IP protocol history</hl>
This will generate on the Info menu, the following line:
* history: : History of IP protocol
The node and menu attribute may be used independently: the attribute that is not used,
will be determined automatically.
Having access to nodes, it is possible to use them for cross reference, without the need
for the id attribute.
Sgmltexi creates automatically the Top node menu. As already explained before (see
[top node menu], page 11), the menu can be explicitly defined. In this way, all nodes and
descriptions must be made manually.
Inserting the menu element at the bottom of a chapter, or at a lower section, will ask an
insertion of a lower Info menu. See the example:
<hl>IP protocol history</hl>
<p>Bla bla bla. . .</p>
<p>Bla bla bla. . .</p>
<menu>
<h2>IS0/0SI model</h2>
<p>Bla bla bla. . .</p>
<p>Bla bla bla. . .</p>
<h2>More inf ormation</h2>
<p>Bla bla bla. . .</p>
<p> . . . </p>
The example shows the insertion of an automatic Info menu before h2 sections. This
menu may otherwise be described completely, like this:
<menu>
Chapter 2: Sectioning, nodes and menus
15
* IP layer:: IP ISO/OSI layer model
* more on IP: : More details on IP
</menu>
When the menu is described this way, node names must be the same as the one used
with the heading elements. That is: when writing the menu, also nodes must be exactly
declared, like this:
<hl>IP protocol history</hl>
<p>Bla bla bla. . .</p>
<p>Bla bla bla. . .</p>
<menu>
* IP layer: :
* more on IP: :
</menu>
IP ISO/OSI layer model
More details on IP
<h2 node="IP layer" >IS0/0SI model</h2>
<p>Bla bla bla. . .</p>
<p>Bla bla bla. . .</p>
<h2 node="more on IP">More inf ormation</h2>
<p>Bla bla bla. . .</p>
<p> . . . </p>
It is evident that a menu attribute (like <h2 menu="Much more inf ormation">) has no
effect in this case.
Element
tomeheading
partheading
hi
h2
h3
h4
indexheading
Attribute
Content
in-line
in-line
in-line
in-line
in-line
in-line
node
menu
next
prev
up
type
numbered,
unnumbered,
heading
Description or Texinfo equivalence
title of a tome
title of a part
title of a chapter, introduction or appendix
title of a section
title of a subsection
title of a sub-subsection
title of an analytic index
Info node name
Info node description
Next node name
Previous node name
Up node name
type of section, for hi to h4 elements
Chapter 2: Sectioning, nodes and menus
16
2.1 Unnumbered sections and simple headings
Elements hi, h2, h3 and h4 may have an additional attribute: type. The keywords
numbered, unnumbered and heading may be assigned, numbered is the default value; it
means that the title will be numbered (with numbers if inside body, with letters if inside
appendix). Assigning unnumbered, the titles are not numbered. Assigning heading, the
titles are not numbered and not annotated inside the table of context.
<hl type= "unnumbered '^Acknowledgement s</hl>
Inside the intro elements, titles cannot be numbered: it is explicitly excluded.
Chapter 3: Block and in-line
17
3 Block and in-line
Sgmltexi has a DTD where most of the elements are divided into two categories, block
and in-line, with the help of two parameter entities: block and inline (SGML macro are
"/.block;' and "/.inline;').
A block is something like a paragraph, a list, a table; an in-line is text, text emphatisa-
tion, anchors, cross references, and other things that stay inside a text.
Usually, but not necessarily, an in-line element contains text and possibly other in-line
elements; but a block element may be made to contain in-line or other blocks. The Sgmltexi
DTD don't consider the possibility of block elements that may contain either block or in-
line. These kinds of contents are known as "flow" (this name is used inside the HTML
DTD) and are rarely useful.
Some block elements, like example, may contain block elements or a single pre element
(a special block element not classified as part of the '%block;' macro). The pre element
can contain only in-line that is preformatted, that is: it maintains line breaks.
The two basic block element are shown in the following table:
Element Attribute Content Description or Texinfo equivalence
p in-line paragraph, or simple block of text
indent on, off first line indentation; default is on
center in-line ©center
Chapter 4: Index and cross reference
18
4 Index and cross reference
There are different kind of insertions for making indexes and cross references, that re-
produce equivalent Texinfo commands.
4.1 Indexes
Index entries are inserted with a group of empty elements: cindex, f index, vindex,
kindex, pindex, tindex and userindex. All these elements have the same attribute,
entry, that define the item text to be inserted. The userindex has an additional attribute,
to define the user index name (that should be made of two letters).
These elements are a kind of block that may be inserted just after any sectioning title,
like this:
<hl>IP protocol history</hl>
<cindex entry="IP protocol">
<cindex entry="history">
<p>Bla bla bla. . .</p>
The following table resumes the meaning for so many different index entry elements.
Element
Attribute
Content
Description or Texinfo equivalence
cindex
entry
empty
concept index item
findex
entry
empty
function index item
vindex
entry
empty
variable index item
kindex
entry
empty
keystroke index item
pindex
entry
empty
program index item
tindex
entry
empty
data type index item
userindex
entry
empty
user defined index item
name
user defined index name (two letters
printindex
name
print the named index (two letters)
The index is inserted with the element printindex, already described. Standard index
names are listed in the following table.
Index name Description
cp concept index,
ky keystroke index,
pg program index,
fn function index,
vr variable index,
tp data type index.
4.2 Cross references
Cross reference elements are all in-line empty elements. All information is given via
attributes. As all cross reference elements are implementations of equivalent Texinfo com-
mands, there is only the following table as description. Every attribute description follow
its own element. Please note that not all attributes are necessary.
Chapter 4: Index and cross reference
Element Attribute
anchor
id
xref
id
name
title
info
ptitle
ref
id
name
title
info
ptitle
pxref
id
name
title
info
ptitle
inforef
id
name
info
uref
uri
name
replace
email
email
name
Use like this:
Content Description or Texinfo equivalence
empty ©anchor
anchor identity string
empty Oxref
node or anchor name
cross reference name
title or topic
info file name
printed manual title
empty @ref
node or anchor name
cross reference name
title or topic
info file name
printed manual title
empty Opxref
node or anchor name
cross reference name
title or topic
info file name
printed manual title
empty Oinforef
node or anchor name
cross reference name
info file name
empty Ouref
URI address
title or description
replacement text
empty ©email
electronic mail address
title or description
<p>Sgmltexi creates automatically the Top node menu. As already
explained before (<pxref id="top node menu">) , the menu can be
Chapter 5: Marking words and phrases
20
5 Marking words and phrases
A lot of in-line elements are used to mark words or phrases. Actually, the DTD is very
permissive, so that every element of these can contain any in-line element. It is so only to
assure compatibility with Texinfo, but may change in the future. The following table list
these elements, included kbdinputstyle, used to select the style for the kbd element.
Element
Attribute
Content
Description or Texinfo
code
in-line
©code
kbd
in-line
©kbd
kbdinputstyle
empty
©kbdinputstyle
style
code, example,
how to show keyboard
distinct
is distinct
key
in-line
©key
samp
in-line
©samp
var
in-line
©var
env
in-line
@env
file
in-line
©file
command
in-line
©command
option
in-line
©option
dfn
in-line
©dfn
cite
in-line
©cite
acronym
in-line
©acronym
url
in-line
©url
emph
in-line
©emph
strong
in-line
©strong
sc
in-line
©sc
roman
in-line
@r
italic
in-line
@i
bold
in-line
@b
typewriter
in-line
@t
Use like this:
<p><strong>Pinco Pallino</strong> is a very old man.
</p>
<p><strong>Tizio Tizi</strong> studied telecommunication
technology. . .</p>
Chapter 6: Marking block of text
21
6 Marking block of text
Some block elements are used to mark other block of text or special kind of in-line text.
The DTD is very permissive, to assure maximum compatibility with Texinfo, but this may
change in the future. The following table list these elements, included the special element
pre, used to insert in-line preformatted text, and exdent, used inside pre to obtain an
exuenceu nne.
Element Attribute
Content
Description or Texinfo equivalence
exdent
in-line
©exdent
pre
in-line
preformatted text
quotation
block
©quotation
display
block or pre
©display
smalldisplay
block or pre
©smalldisplay
example
block or pre
©example
smallexample
block or pre
©smallexample
fiushleft
in-line
©fiushleft
flushright
in-line
©flushright
lisp
block or pre
©lisp
smalllisp
block or pre
©smalllisp
cartouche
block or pre
©cartouche
format
block or pre
©format
smallformat
block or pre
©smallformat
texinfo
literal Texinfo
embedded literal Texinfo code
Use like this:
<example>
<p>Hello everybody</p>
<p>Hello to the world</p>
</example>
In this case the example element contains preformatted text (please not the use of two
SGML entities, It and gt):
<example>
<pre>
# ! /usr/bin/perl
while ($line = < ; STDIN> ; )
{
chomp $line;
print ("$line\r\n") ;
>
</pre>
</example>
If it is necessary to include a preformatted literal text, do like this (please note that
there is no need to hide '<' and '>'):
<example>
<pre>
< ! [CDATA [
Chapter 6: Marking block of text
# ! /usr/bin/perl
while ($line = <STDIN>)
{
chomp $line;
print ("$line\r\n")
>
]]>
</pre>
</example>
Chapter 7: List and tables
23
7 List and tables
List and tables are block elements. The following table list the elements used to imple-
ment list and tables.
Element
itemize
enumerate
table
vtable
ft able
item
itemx
multitable
Attribute Content
mark
start
emphasis
emphasis
emphasis
Description or Texinfo equivalence
itemx, ©itemize
item,
block
item,
block
item,
block
asis, code, emphasis for the descriptive item
samp, var, kbd,
file
item,
block
asis,
itemx,
itemx,
mark before items; default is '&bull ; '
©enumerate
starting number
Stable
itemx, Ovtable
columnfraction
columnexample
raw
tab
code
samp, var, kbd
item, itemx, Oftable
block
asis, code
samp, var, kbd
in-line or ©item
empty
in-line or 0 itemx
empty
columnfraction Omultitable
or
columnexample;
raw
.n
emphasis for the descriptive variable item
emphasis for the descriptive function item
column fraction, where ".n" is the O.n frac-
tion of the horizontal space
pure text column fraction, where the inserted text
gives the example of the column extention
in-line, tab row of the table
empty column separation
It follows some examples; first an unnumbered list:
<itemize mark="#">
<item>
<p>First item.</p>
<item>
<p>Second item.</p>
</ itemize>
Chapter 7: List and tables
24
Here is the result:
# First item.
# Second item.
Here is a numbered list:
<enumerate start="3">
<item>
<p>First item.</p>
<item>
<p>Second item.</p>
</enumerate>
Here is the result:
3. First item.
4. Second item.
Here is a descriptive list:
<table emphasis="code">
<item>ls</ item>
<itemx>dir</itemx>
<p>List directory contents . </p>
<item>cd</ item>
<p>Change directory . </p>
</table>
Here is the result:
Is
dir List directory contents,
cd Change directory.
Chapter 8: Insertions
25
8 Insertions
Here are described some
two types of such insertions
list the in-line elements and
Element Attribute
dmn
math
mixed elements that have not found a better place. There are
: in-line and block insertions. The first of the following tables
the second the block elements.
footnote
image
whole
br
dh
hyphenation
Element
sp
page
group
need
name
width
height
words
Attribute
lines
mils
Content
parsed charac-
ter data
parsed charac-
ter data
in-line
empty
in-line
empty
empty
empty
Content
empty
empty
block
empty
Description or Texinfo equivalence
@dmn
©math
©footnote
©image
file name to be inserted (without extention)
image width
image height
@w (preventing line break)
@* (line break)
@- (discretionary hyphen)
©hyphenation
list of hy-phen-a-ted words
Description or Texinfo equivalence
@sp
skip n lines
©page
©group
©need
thousandths of inch
Chapter 9: Definitions
26
9 Definitions
Here are
Element
args
deffn
deffhx
defun
defunx
defmac
defmacx
defspec
defspecx
defvr
defvrx
defvar
defvarx
defopt
defoptx
deftypefn
deftypefnx
deftypefun
deftypefunx
deftypevr
deftypevrx
deftypevar
deftypevarx
dcfcv
described the elements implementing Texinfo definitions.
Attribute
cat
name
name
name
name
cat
name
name
name
cat
type
name
type
name
cat
type
name
data type
name
Content
in-line
args, block
empty
args, block
empty
args, block
empty
args, block
empty
block
empty
block
empty
block
empty
args, block
empty
args, block
empty
block
empty
block
empty
block
Description or Texinfo equivalence
argument of a definition
©deffn
function category
function name
©deffnx, attributes like deffn
©defun
function name
©defunx, attributes like defun
©defmac
macro name
©defmacx, attributes like defmac
©defspec
special form name
©defspecx, attributes like defspec
©defvr
variable category
variable name
©defvrx, attributes like defvr
©defvar
variable name
©defvarx, attributes like defvar
©defopt
option name
©defoptx, attributes like defopt
©deftypefn
category
data type
name
©deftypefnx, attributes like deftypefn
©deftypefun
data type
name
©deftypefunx, attributes like deftypefun
©deftypevr
category
data type
name
©deftypevrx, attributes like deftypevr
©deftypevar
type
name
©deftypevarx, attributes like deftypevar
©def cv
Chapter 9: Definitions
27
defcvx
defivar
defivarx
deftypeivar
deftypeivarx
defop
defopx
deftypeop
deftypeopx
defmethod
cat
class
name
class
name
class
type
name
cat
class
name
cat
class
type
name
class
name
defmethodx
deftypemethod
class
type
name
deftypemethodx
deftp
cat
name
deftpx
empty
block
empty
block
empty
args, block
empty
args, block
empty
args, block
empty
args, block
empty
args, block
empty
category
class
name
©defcvx, attributes like def cv
©defivar
class
name
©def ivarx, attributes like defivar
©deftypeivar
class
type
name
©deftypeivarx, attributes like
deftypeivar
©defop
category
class
name
©def opx, attributes like defop
©deftypeop
category
class
type
name
©deftypeopx, attributes like deftypeop
©defmethod
class
name
©defmethodx, attributes like defmethod
©deftypemethod
class
type
name
©deftypemethodx, attributes like
deftypemethod
©deftp
category
name
©deftpx, attributes like deftp
It follows an example about the use of def f n:
<deffn cat="Command" name="sgmltexi">
<args> [<var>options</var>] . . . <var>sgml_source</var></args>
<p>This is the front-end for the SGML to Texinfo system. </p>
</deffn>
Chapter 9: Definitions
28
Here is the result:
sgmltexi [options]... sgmLsource [Command]
This is the front-end for the SGML to Texinfo system.
Chapter 10: Conditional and literal back-end code
29
10 Conditional and literal back-end code
Texinfo has a special handling capability to select code depending on the final typeset-
ting. Things like these can be done with SGML using marked sections, but it is not exactly
the same thing. Sgmltexi includes some special elements to implement the conditional code
insertion used inside Texinfo, and allow to insert also some peace of literal code.
Element
ifinfo
ifinfoblock
iftex
iftexblock
ifhtml
ifhtmfblock
ifplaintext
ifplaintext block
ifxml
ifxmlblock
ifnotinfo
ifnotinfoblock
ifnottex
ifnottexblock
ifnothtml
ifnothtmlblock
ifnotplaintext
ifnotplaintextblock
Attribute
Content
in-line
block
in-line
block
in-line
block
in-line
block
in-line
block
in-line
block
in-line
block
in-line
block
in-line
block
Description or Texinfo equivalence
©ifinfo ... Send ifinfo
©ifinfo ... Send ifinfo
©iftex ... Send iftex
©iftex ... Send iftex
©ifhtml ... ©end ifhtml
©ifhtml ... ©end ifhtml
©ifplaintext ... Send ifplaintext
©ifplaintext ... ©end ifplaintext
©ifxml ... ©end ifxml
©ifxml ... ©end ifxml
©ifnotinfo ... ©end ifnotinfo
©ifnotinfo ... ©end ifnotinfo
©ifnottex ... ©end ifnottex
©ifnottex ... ©end ifnottex
©ifnothtml ... ©end ifnothtml
©ifnothtml ... ©end ifnothtml
©ifnotplaintext
©end ifnotplaintext
©ifnotplaintext
©end ifnotplaintext
©ifnotxml ... ©end ifnotxml
©ifnotxml ... ©end ifnotxml
©tex ... ©end tex
©html ... ©end html
Raw Texinfo code.
ifnotxml in-line
ifnotxmlblock block
tex parsed charac-
ter data
html parsed charac-
ter data
texinfo parsed charac-
ter data
Please note that ifinfo, iftex, ifhtml, ifplaintext, ifxml, ifnotinfo, ifnottex,
ifnothtml, ifnotplaintext and ifnotxml, are in-line elements that contain in-line
text. On the other side, ifinfoblock, iftexblock, ifhtmlblock, if plaintextblock,
ifxmlblock, ifnotinfoblock, ifnottexblock, ifnothtmlblock, ifnotplaintextblock
and ifnotxmlblock, are block elements that contain block text.
The distinction between if . . . and if . . .block is necessary to avoid trouble with the
SGML document type declaration.
The in-line elements tex, html and texinfo, are made to contain in-line literal text,
usually enclosed inside '<! [CDATA [' and ']]>'.
The element texinfo has no equivalence inside Texinfo, as it represent just raw Texinfo
code. See the following example:
<p>The letter <texinf o>@ubaraccent{o}</texinf o> is a special ... </p>
Chapter 10: Conditional and literal back-end code
30
It may be necessary to force literal reading, as for SGML. In this case, the element
content can be enclosed like this:
<p>The letter <texinf o>< ! [CDATA [@ubaraccent{o>] ] ></texinf o> is a...
The example doesn't show any real reason to put the text inside a CDATA environment,
but there are other situations where it will be necessary.
It follows another example on the use of literal back-end code. The intention is to show
a simple mathematical expression: 123 + 10" (-1).
<p><tex>< ! [CDATA [$123+10" {-1}$] ] ></tex>
<html>< ! [CDATA [123+10<sup>-K/sup>] ] ></html>
<if info>123+10~-K/if inf o>
= 12.3</p>
As current typesetting is made for TeX the result is as it follows:
123 + 10- 1 = 12.3
10.1 Troubles
Texinfo, like TeX and *roff, distinguishes blocks because these are separated from one
or more lines. This way, the distinction between blocks and in-lines is only a matter of
vertical space. For example, the following peace of Texinfo source shows three environments
@if typesetting, which are part of the same block of text (the same paragraph). That is:
in-line.
Current typesetting is
Oiftex
TeX
Send iftex
Oifhtml
HTML
Send ifhtml
@if inf o
Info
Send if info
and you can see that . . .
But in a different situation, these environments can became isolated block of text, like
this:
Current typesetting is:
©iftex
TeX
Send iftex
Oifhtml
HTML
Chapter 10: Conditional and literal back-end code
31
Send ifhtml
@if inf o
Info
Send if info
You can see that . . .
With SGML this is not desirable, and difficult to implement. This is the reason
why Sgmltexi distinguishes from @if typesetting or @if nottypesetting, and
@if typesettingblock or @if nottypesettingblock.
Sgmltexi try to preserve line breaks inside the SGML source, but in this case, there is
a consequence on the use of such conditional in-line environments. This happens because
Texinfo requires these commands to lay alone on a single line. That is, if we would like to
write something like this:
<p>Current typesetting
is <if tex>TeX</if texxif html>HTML</if htmlxif inf o>Inf o</if inf o> , so
you know what I mean.</p>
we expect that opening and closing tags will introduce proper line breaks. But if it were
so, the result would be the following, transforming original in-line into undesired final block:
Current typesetting is
Oiftex
TeX
Send iftex
©ifhtml
HTML
Send ifhtml
@if inf o
Info
Send if info
, so you know what I mean.
To resolve this problem, these in-line conditional tags don't introduce any initial and
final line break: it is up to the author to think about this problem. This way, Sgmltexi
must be used in the following way, considering that there is no way to put the comma after
the typesetting name:
<p>Current typesetting is
<iftex>TeX</iftex>
<ifhtml>HTML</ifhtml>
<if info>Inf o</if inf o>
so you know what I mean.</p>
The same problem happens with tex and html elements, but in this case there is no
need to distinguish the content, that is meant to be always in-line.
<p>
<tex>
Chapter 10: Conditional and literal back-end code
32
$$ \chi~2 = \sum_{i=l}~N
\left (y_i - (a + b x_i)
\over \sigma_i\right) ~2 $$
</tex>
</p>
When using SGML, inserting literal back-end code is just a last resort that breaks
standardization. In other words, if it is necessary to use such expedient, maybe the SGML
is the wrong choice for writing documentation.
J
Chapter 11: How to use the front-end
33
11 How to use the front-end
When the Sgmltexi source is ready, all that is needed is the program sgmltexi to control
the SGML parser and other elaborations.
sgmltexi [options]... sgmLsource [Command]
This is the front-end for the SGML to Texinfo system.
— help' Display a brief help and exit.
— version'
Display version information and exit.
— verbose'
Display processing information.
— force' Force things.
— number-sections'
Number sections for Info and HTML typesetting.
— clean' Remove stale files associated with the source name.
— input-encoding= encoding'
Define an input encoding that will be converted automatically into entities. This
option take precedence over the attribute charset of the sgmltexi element.
Using this option the Texinfo source will be pure ASCII, and the command
Odocumentencoding is used with the argument 'ISO-646'.
Available encodings are: 'ISO-8859-1', 'ISO-8859-2', ... 'ISO-8859-10'. All
encodings are not fully supported, because of Texinfo limitations. Unsupported
codes are shown with the name of the corresponding standard entity, like this:
'[ETH ]'.
' — sgml-include=parameter-entity'
' — include=parameter-entity'
Assign the word INCLUDE to an SGML parameter entity.
' — paper=paper'
Define the paper format: letter, a4, a4wide, a41atex, small.
' — setchapternewpage={on | off | odd}'
Define the chapter paper feed, overriding the tag <setchapternewpage
content=" . . . "> inside the source.
' — f ootnotestyle={end | separate}'
Define the footnote location, overriding the tag <f ootnotestyle
content=" . . . "> inside the source.
' — sgml-syntax'
' — sgml-check'
Check SGML syntax and report errors.
' — sp' SP output for debugging purpose.
Chapter 11: How to use the front-end
34
' — texi'
' — texinf o'
Generate a Texinfo source output.
'— dvi'
Generate
a DVI output.
<-ps'
' — postscript'
Generate
a PostScript output.
'--pdf
Generate
a PDF output.
'—info'
Generate
an Info output.
'—text'
Generate
a text output.
'—html'
Generate
an HTML output.
'— xml'
Generate
a Texinfo XML output
' — docbook
Generate a Docbook XML output.
Each elaboration generates a file with ' . diag' extention. This file contains the messages
that may be shown with the option ' — verbose'.
Chapter 12: How to install
35
12 How to install
Sgmltexi is made of two Perl executables: sgmltexi and sgmltexi-sp2texi. These files
can be placed everywhere they can run without giving the path; that is: inside a directory
listed by the environment variable PATH.
It is needed Perl as '/usr/bin/perl'. If your system is organized differently, you should
modify the first line of these executables:
# ! /usr/bin/perl
#. . .
Sgmltexi expect to find some files:
'/usr/ share/sgmltexi/ sgmltexi . cat'
the Sgmltexi SGML catalog;
'/usr/ share/sgmltexi/ sgmltexi . del'
the Sgmltexi SGML declaration;
'/usr/ share/sgmltexi/ sgmltexi . dtd'
the Sgmltexi DTD;
'/usr/ share/sgmltexi/ entities/'
the directory containing the standard ISO 8879 entity files.
All these files may be exactly where expected or there may be symbolic links to recreate
the expected files.
12.1 Gettext
The messages that Sgmltexi shows may be translated. To install the already translated
PO files, it is necessary to compile them like this:
msgfmt -o sgmltexi. mo it.po
In this example the file 'it.po' is compiled and it is generated the file 'sgmltexi .mo'.
This generated file must be copied inside the right directory; in this case, may be
7usr/share/locale/it/LC_MESSAGES/'.
If you don't have installed the Perl-gettext module and you don't want to worry about
it, you can comment the following instructions:
# We *don't* want to use gettext.
#use POSIX;
#use Locale: : gettext;
#setlocale (LC_MESSAGES , "");
#textdomain ("sgmltexi");
Then you have to introduce a dummy gettext () function:
sub gettext
{
return $_ [0] ;
}
Chapter 13: Dependencies
36
13 Dependencies
Sgmltexi depends on the following external software:
Perl the Perl interpreter;
SP
Jade the SGML parser known as SP, that may also be included inside Jade;
Perl-gettext
a Perl module that include Gettext support;
Texinfo
TeX to get a final typesetting.
Chapter 14: Encoding 37
14 Encoding
Sgmltexi has an incomplete support for ISO 8859-n encodings. It is incomplete because
Texinfo is not able to reproduce all characters. There are two ways to define the use of one
encoding with Sgmltexi: the option ' — input-encoding' and the attribute charset inside
the sgmltexi element.
The choice has a different result. The option ' — input-encoding' generate a transfor-
mation of characters into SGML entities, and back to Texinfo code. This way, the Texinfo
code is surely pure ASCII (ISO 646), and entities that have no corresponding Texinfo code,
are shown like ' [ETH ] '. The use of the charset attribute results only on the command
Odocumentencoding; on some occasions, the result may be good or not. Depending on the
better result, it may be used one option or the other.
A good strategy may be the use of the charset attribute in any case, adding the op-
tion ' — input-encoding' when Texinfo doesn't generate a good result alone, usually when
typesetting for printing.
14.1 Standard and non-standard entities
Sgmltexi DTD include all standard ISO 8879 entities (Appendix A [ISOnum], page 61,
Appendix B [ISOpub], page 63, Appendix C [ISOtech], page 65, Appendix D [ISOlatl],
page 67, Appendix E [IS01at2], page 69). In fact, non all entities are really supported by
Texinfo, and when an unsupported entity is used, it is shown on the final typesetting like a
name enclosed inside square brackets, like ' [ETH ] '.
Sgmltexi uses some non-standard entities, needed for compatibility with Texinfo. These
are shown on the following table.
SGML macro
Texinfo
command
Appearing
Description
&dots;
OdotsO
three dots
&enddots;
@enddots{}
four dots
&TeX;
©TeX-Q
LEX
the name "TeX"
&xesult;
©result {}
^expansion;
@expansionO
1 r
&print;
Oprint-Q
H
&error;
©error -Q
|error|
&point;
©point {}
&today;
Otoday-Q
31 March 2003
&esexcl;
0!
!
ending sentence exclamation mark
&esperiod;
6.
ending sentence period
&nes;
6:
not ending sentence
&esquest;
«?
?
ending sentence question mark
Chapter 15: Supported and unsupported Texinfo feature
38
15 Supported and unsupported Texinfo feature
Some Texinfo features are supported, others are not. Here is the list.
Qwhitespace
&emsp ;
@! feesexcl; (end sentence exclamation mark)
8"
@' Use equivalent standard SGML entities, or ISO 8859-n characters if available.
@* <br>
@,{c}
@,{C} Use equivalent standard SGML entities, or ISO 8859-n characters if available.
8- <dh>
8. feesperiod; (end sentence period)
8: fenes; (not ending sentence)
8= Unsupported. 1
8? feesquest ; (end of sentence question mark)
88 Simply 0.
8"
0' Use equivalent standard SGML entities, or ISO 8859-n characters if available.
0{
0} Simply { and }.
0~
0AAO
OaaO Use equivalent standard SGML entities, or ISO 8859-n characters if available.
Sacronym{abbrev}
<acronym>abbrev</acronym>
0AEO
©aeO Use equivalent standard SGML entities, or ISO 8859-n characters if available.
@af ivepaper
@af ourpaper
@af ourlatex
@af ourwide
Use command line option: ' — paper=a5', ' — paper=a4', ' — paper=a41atex',
' — paper=a4wide'.
©alias new - existing
Unsupported. May be used inside the texinfo element.
1 Are there standard SGML entities? I need advice.
Chapter 15: Supported and unsupported Texinfo feature
39
@anchor{name }
<anchor id="name">
©appendix title
Oappendixsec title
Oappendixsection title
Oappendixsubsec title
Oappendixsubsection title
Oappendixsubsubsec title
Oappendixsubsubsection title
Appendixes are enclosed inside the appendix element.
Oasis The word asis is used as an argument for the emphasis attribute for table,
vtable and ftable elements.
©author author
<author>author </ author>
@b{text} <bold>text</bold>
ObulletO
febull ;
@bye </sgmltexi>
@c comment
©comment comment
Unsupported, as SGML has its own comment symbol. May be used inside the
texinfo element.
©cartouche
<cartouche>text-blocic</cartouche>
©center line-of -text
<center>line-of-text</center>
Unsupported on title page.
Ocenterchap title
Unsupported.
Ochapheading title
<hl type="heading">title</hl>
©chapter title
<hl>title</hl>
Scindex entry
<cindex entry= " entry ">
@cite{ref erence }
<cite>ref erence</ cite>
Oclear flag
Unsupported. May be used inside the texinfo element.
Chapter 15: Supported and unsupported Texinfo feature
40
@code{sample}
<code> sample </code>
@command{ command-name }
<command> command-name </command>
©contents
<contents>
OcopyrightO
Use equivalent standard SGML entities, or ISO 8859-n characters if available.
@def codeindex index-name
<def codeindex> index-name </def codeindex>
Odefcv category class name
Odefcvx category class name
<defcv cat=" category " class=" class " name="name ">
[<defcvx cat=" category " class=" class " name="name ">] . . .
</def cv>
@deffn category name argument. . .
@deffnx category name argument. . .
<deffn cat=" category" name="name ">
<args> argument . . .</args>
[<deffnx cat=" category " name="name ">
<args>argument . . .</args>] . . .
</deffn>
@def index index-name
<def index>index-name </def codeindex>
@def inf oenclose newcmd, before, after,
Unsupported. May be used inside the texinfo element.
@defivar class instance-variable-name
Odefivarx class instance-variable-name
<defivar class=" class " name=" instance-variable ">
[<defivarx class=" class " name=" instance-variable ">]
</def ivar>
Odefmac macro-name argument. . .
Sdefmacx macro-name argument. . .
<defmac name= "macro-name ">
<args>argument . . .</args>
[<defmacx name= "macro-name ">
Chapter 15: Supported and unsupported Texinfo feature
<a.rgs> argument . . .</args>] . . .
</defmac>
@def method class method-name argument. . .
Odefmethodx class method-name argument. . .
<def method class=" class " name= "method-name ">
<args> argument . . .</args>
[<defmethodx class=" class " name= "method-name ">
<args>argument . . .</args>] . . .
</defmethod>
@defop category class name argument. . .
Odefopx category class name argument. . .
<defop cat=" category " class=" class " name="name">
<args>argument . . .</args>
[<defopx cat=" category " class=" class " name="name'
<args>argument . . .</args>] . . .
</def op>
Odefopt option-name
Sdefoptx option-name
<defopt name= "option -name ">
[«defoptx name=" option-name ">] . . .
</def opt>
Qdefspec special -form-name argument. . .
Odefspecx special-form-name argument. . .
<def spec name=" special-form-name ">
<args>argument . . .</args>
[<def specx name=" special-form-name ">
<args>argument . . .</args>] . . .
</def spec>
Sdeftp category name-of-type attribute. . .
@deftpx category name-of-type attribute . . .
<deftp cat=" category" name="name-of-type ">
<args>attribute. . .</args>
[<deftpx cat=" category " name= " name-of-type ">
<args>attribute. . .</args>] . . .
Chapter 15: Supported and unsupported Texinfo feature
42
</deftp>
Qdeftypefn classification data-type name argument. . .
Odeftypefnx classification data-type name argument. . .
<deftypefn cat=" classification " type= " data-type " name="name">
<args> argument . . .</args>
[<deftypefnx cat=" classification " type= " data-type " name="name">
<args> argument . . .</args>] . . .
</def typefn>
Odeftypefun data-type function -name argument. . .
Odeftypefunx data-type function-name argument. . .
<deftypefun type=" data-type " name="f unction-name ">
<args>argument . . .</args>
[<def typefunx type= " data-type " name="f unction-name ">
<args>argument . . .</args>] . . .
</def typefun>
Odeftypeivar class data-type variable-name
@def typeivarx class data-type variable-name
<deftypeivar class=" class " type= " data-type " name=" variable-name ">
[<def typeivarx class=" class " type=" data-type " name=" variable -
name ">]...
</def typeivar>
Odef typemethod class data-type method-name argument. . .
@def typemethodx class data-type method-name argument. . .
<def typemethod class=" class " type=" data-type " name= "method-name ">
<ar gs> argument . . .</args>
[<def typemethodx class="class " type= " data-type " name= "method-
name ">
<args>argument . . .</args>] . . .
</def typemethod>
Odeftypeop category class data-type name argument. . .
Odeftypeopx category class data-type name argument. . .
<deftypeop cat=" category" class=" class " type=" data-type " name="name ">
<args>argument . . .</args>
[<deftypeopx cat=" category " class=" class " type= " data-type " name="name">
<ar gs> argument . . .</args>] . . .
Chapter 15: Supported and unsupported Texinfo feature
43
</def typeop>
@deftypevar data-type variable-name
Odeftypevarx data-type variable -name
<deftypevar type=" data-type " name=" variable-name ">
[<def typevarx type= " data-type " name=" variable-name ">]
</def typevar>
Odeftypevr classification data-type name
Odeftypevrx classification data-type name
<deftypevr cat=" classification" type= " data-type " name="name ">
[<deftypevrx cat=" classification " type= " data-type " name="name ">]
</def typevr>
Odefun function-name argument. . .
Odefunx function-name argument. . .
<defun name="f unction-name ">
<args>argument . . .</args>
[<defunx name="f unction-name ">
<args>argument . . .</args>] . . .
</defun>
Odefvar variable-name
Odefvar variable-name
<defvar name=" variable-name ">
[<defvarx name=" variable-name ">]
</def var>
Odefvr category name
Odefvrx category name
<defvr cat=" category " name="name">
[<defvrx cat=" category " name="name ">] . . .
</defvr>
Odetailmenu
<menu>
<detailmenu>
Chapter 15: Supported and unsupported Texinfo feature
44
</detailmenu>
</menu>
@df n{termj
<dfn>term</dfn>
Odircategory dirpart
Odirentry
<infodir cat= " dirpart ">
</ inf odir>
©display <display>text-blocJc</display>
@dmn{dimension }
<dmn> dimension </dmn>
Odocumentdescription description Send documentdescription
<documentdescription content=" description ">
Odocumentencoding enc
<sgmltexi charset="enc">
This is the input character set, like it can be done with the Texinfo
Odocumentencoding command. It is obscured by the ' — input-encoding'
option, that take precedence and generate a pure ISO 646 Texinfo output.
Odocumentlanguage cc
<sgmltexi lang=" cc">
@dotaccent{c}
Use equivalent standard SGML entities, or ISO 8859-n characters if available.
@dots{} Mots;
@email{address, displayed-text}
<email email=" address " name="displayed-text ">
@emph{text}
<emph>text </ emph>
@env{environment-variable}
<env> environment -vari abl e </env>
@enddots-Q
&enddots ;
©enumerate [number-or-letter]
<enumerate [start="number-or-letter "] >
<item>
Chapter 15: Supported and unsupported Texinfo feature
45
<item>
</enumerate>
@equiv{} feequiv;
@error{} feerror;
Oevenf ooting
Oevenheading
Oeveryf ooting
Oeveryheading
Unsupported. May be used inside the texinfo element.
©example
<example>
block
</example>
Preformatted:
<example>
<pre>
in-line
</pre>
</example>
literal:
<example>
<pre>
< ! [CDATA [
in-line
]]>
</pre>
</example>
Oexampleindent
Unsupported. May be used inside the texinfo element.
Oexlamdown
Use equivalent standard SGML entities, or ISO 8859-n characters if available.
Oexdent
<pre>
Chapter 15: Supported and unsupported Texinfo feature
46
<exdent>some exdented text</exdent>
</pre>
OexpansionO
feexpansion;
Of ile{f ilenamej
<file> filename </file>
Of inalout
Unsupported. Actually it is always included.
Of index entry
<f index entry= " entry ">
Of lushleft
<f lushlef t>text </f lushlef t>
Of lushright
<f lushright>text </ f lushright>
Of ootnote{ text -of -footnote}
<f ootnote> text -of -footnote </f ootnote>
Of ootnotestyle style
<f ootnotestyle content=" style ">, or use command line option:
' — f ootnotestyle=style '.
Of ormat
<f ormat>
<pre>
</pre>
</f ormat >
literal:
<f ormat >
<pre>
< ! [CDATA [
]]>
</pre>
</f ormat >
Of renchspacing
<sgmltexi spacing="f rench">
Oftable formatting— command
<f table emphasis=" command ">
<item>descriptive-item</ item>
Chapter 15: Supported and unsupported Texinfo feature
47
[<itemx>descriptive-item</ itemx>]
text-block. . .
<item>descriptive-item</ item>
[<itemx>descriptive-item</ itemx>]
text-block. . .
</ftable>
©group <group>text-bloc.k</group>
@H{c} Use equivalent standard SGML entities, or ISO 8859-n characters if available.
Sheading title
<h2 type="heading">title</h2>
Sheadings on-off -single-double
<headings content=" on-off -single-double-singleafter-
doubleaf ter ">, or use command line option: ' — headings=on-off-
single-double-singleafter-doubleafter\
Ohtml <html>html_ back_ end_ code </html>
@hyphenation{hy-phen-a-ted words }
<hyphenation words="]iy-piie.n-a-ted words">
@i{text} <italic>text</italic>
Oif clear flag
Unsupported. May be used inside the texinfo element.
@if html There are two possibilities: in-line and block conditionals.
<ifhtml>in-line</ifhtml>
<ifhtmlblock>
block
</ifhtmlblock>
SGML gives the possibility to use marked sections. These can be controlled
with Sgmltexi with the option ' — sgml-include' at the command line. For
example, the SGML source may be like this:
<!D0CTYPE Sgmltexi PUBLIC "-//GNU//DTD Sgmltexi//EN"
[
<! ENTITY % HTML "IGN0RE">
<! ENTITY % INFO "IGN0RE">
<! ENTITY % TEX " IGNORE" >
]>
<sgmltexi>
Chapter 15: Supported and unsupported Texinfo feature
48
<! [%HTML; [
<p>Here it is some text that is meant to appear only inside
the HTML typesetting. </p>
]]>
<! ['/.INFO; [
<p>Here it is some other text that is meant to appear only
inside the Info typesetting. </p>
]]>
<! [7.TEX; [
<p>This text is meant to appear only inside the TeX
typesetting. </p>
]]>
</ sgmltexi>
Then, when typesetting for HTML, the option ' — sgml-include=HTML' must
be used:
sgmltexi — sgml-include=HTML — html my_file.sgml
When typesetting for Info, the option ' — sgml-include=INFO' must be used:
sgmltexi — sgml-include=INFO — info my_file.sgml
The same way, when typesetting for TeX, the option ' — sgml-include=TEX'
must be used:
sgmltexi — sgml-include=TEX — info my_file.sgml
@if inf o There are two possibilities: in-line and block conditionals.
<if inf o> in-line </ if inf o>
<if inf oblock>
block
</ if inf oblock>
SGML gives also the possibility to use marked sections. See Sifhtml for the
explanation.
@if nothtml
There are two possibilities: in-line and block conditionals.
<if nothtml>in-2ine</ if nothtml>
<if nothtmlblock>
block
</ if nothtmlblock>
SGML gives the possibility to use marked sections. These can be controlled
with Sgmltexi with the option ' — sgml-include' at the command line. For
example, the SGML source may be like this:
Chapter 15: Supported and unsupported Texinfo feature
49
<!D0CTYPE Sgmltexi PUBLIC "-//GNU//DTD Sgmltexi//EN"
[
<! ENTITY % NOTHTML "IGN0RE">
<! ENTITY % NOTINFO "IGN0RE">
<! ENTITY '/, NOTTEX "IGN0RE">
]>
<sgmltexi>
< ! [7.N0THTML ; [
<p>Here it is some text that is meant to appear only outside
the HTML typesetting . </p>
]]>
< ! [7.N0TINF0 ; [
<p>Here it is some other text that is meant to appear only
outside the Info typesetting. </p>
]]>
< ! [%N0TTEX ; [
<p>This text is meant to appear only outside the TeX
typesetting. </p>
]]>
</ sgmltexi>
Then, when typesetting for HTML, the options ' — sgml-include=NOTINFO' and
' — sgml-include=NOTTEX' must be used:
sgmltexi — sgml-include=NOTINFO — sgml-include=NOTTEX — html my_file.sgml
When typesetting for Info, the options ' — sgml-include=NOTHTML' and
! — sgml-include=NOTTEX' must be used:
sgmltexi — sgml-include=NOTHTML — sgml-include=NDTTEX — info my_file.sgml
The same way, when typesetting for TeX, the options ' — sgml-include=NOTINFD'
and ' — sgml-include=NOTHTML' must be used:
sgmltexi — sgml-include=NOTINFO — sgml-include=NOTHTML — tex my_file.sgml
@if notinf o
There are two possibilities: in-line and block conditionals.
<if notinf o>in-2ine</ if notinf o>
<if notinf oblock>
block
</ if notinf oblock>
SGML gives also the possibility to use marked sections. See Oifnothtml for
the explanation.
Chapter 15: Supported and unsupported Texinfo feature
50
@if notplaintext
There are two possibilities: in-line and block conditionals.
<if notplaintext>in-line</ if notplaintext>
<if notplaintextblock>
block
</ if notplaintextblock>
SGML gives also the possibility to use marked sections. See Oifnothtml for
the explanation.
@if nottex
There are two possibilities: in-line and block conditionals.
<if nottex>in-2ine</ if nottex>
<if nottexblock>
block
</ if nottexblock>
SGML gives also the possibility to use marked sections. See Oifnothtml for
the explanation.
@if notxml
There are two possibilities: in-line and block conditionals.
<if notxml>in-2ine</ if notxml>
<if notxmlblock>
block
</ if notxmlblock>
SGML gives also the possibility to use marked sections. See Oifnothtml for
the explanation.
@if plaintext
There are two possibilities: in-line and block conditionals.
<if plaint ext> in-line </ if plaint ext>
<if plaint extblock>
block
</ if plaintextblock>
SGML gives also the possibility to use marked sections. See Oifhtml for the
explanation.
Oifset flag
Unsupported. May be used inside the texinfo element.
@if tex There are two possibilities: in-line and block conditionals.
<if tex> in-line </ if tex>
<if texblock>
block
Chapter 15: Supported and unsupported Texinfo feature
51
</ if texblock>
SGML gives also the possibility to use marked sections. See Sifhtml for the
explanation.
There are two possibilities: in-line and block conditionals.
<if xml> in-line </ if xml>
<if xmlblock>
block
</ if xmlblock>
SGML gives also the possibility to use marked sections. See Sifhtml for the
explanation.
Unsupported. May be used inside the texinfo element. If it is not necessary
to have the text included inside the generated Texinfo source, standard SGML
comments may be used:
<! —
This text is a comment, that is not reported
inside the Texinfo generated source.
— >
@image{f ilename, [width] , [height] }
<image name="f ilename " width=" width " he ight=" height ">
©include Unsupported (see below). Use SGML mechanism instead, like this:
<!D0CTYPE Sgmltexi PUBLIC "-//GNU//DTD Sgmltexi//EN"
[
<! ENTITY GPL SYSTEM "licenses/gpl . sgml">
< ! ENTITY BSD SYSTEM "licenses/bsd. sgml">
]>
<sgmltexi>
<appendix>
&GPL;
&BSD;
</appendix>
</ sgmltexi>
@if xml
©ignore
Chapter 15: Supported and unsupported Texinfo feature
52
As it can be seen, the insertion of 'licenses/gpl . sgml' and
'licenses/bsd. sgml' happens when the SGML macro '&GPL;' and
'&BSD ; ' appear inside the source.
If it is necessary to include a Texinfo file, the element texinfo may be used
like this:
<p><texinf o>
©include example . texi
</texinf o></p>
Please remember that texinfo is an in-line element.
Oinforef {node-name, [entry -name] , inf o- file-name}-
<inforef id="node-name " name="entry-name " inf o="info-f ile-name ">
\input macro-definition- file
Unsupported.
©item See ©table, Oftable, Ovtable, ©itemize, ©enumerate and Omultitable.
©itemize [mark]
<itemize [mark="mark"] >
<item>
<item>
</ itemize>
Oitemx See Stable, Oftable and Ovtable.
@kbd{keyboard-characters }
<kbd>keyboard-characters </kbd>
Okbdinput style style
<kbdstyle style= " style ">
@key{key-name }
<key>key-name </key>
Okindex entry
<kindex entry= " entry ">
@L{>
@1{} Use equivalent standard SGML entities, or ISO 8859-n characters if available.
Olisp
<lisp>
block
</lisp>
Preformatted:
Chapter 15: Supported and unsupported Texinfo feature
<lisp>
<pre>
in-line
</pre>
</lisp>
literal:
<lisp>
<pre>
< ! [CDATA [
in-line
]]>
</pre>
</lisp>
Slower sect ions
Unsupported.
©macro macro-name {params}
Unsupported. May be used inside the texinfo element.
Omaj orheading title
Unsupported. Maybe when Texinfo introduce ©part.
Omath-Cmathematical -expression}
<math>mathemati cal -expression </math>
©menu <menu> [info-menu </menu>]
Ominus-Q feminus;
Omultitable column-width-spec
<multitable>
<columnf raction> columnfracti on </columnf raction> .
<raw>element [<tab>element] . . .</raw>. . .
</multitable>
<multitable>
<columnexample>text-example</columnexample> . . .
<raw>element [<tab>element] . . .</raw>. . .
</multitable>
©need n <need mils="n ">
©node name, next, previous , up
Use like this for standard manual node handling:
Chapter 15: Supported and unsupported Texinfo feature
54
<hn node="name ">title</hn>
If it is required a complete control over nodes, also next, previous and up nodes
may be specified, like this:
<hn node="name" next="next" prev=" previous " up="up" >title</hn>
Sgmltexi doesn't make any validity check over manual node insertions.
Onoindent
<p indent="off ">
Onovalidate
Unsupported. May be used inside the texinfo element.
00
o-Q Use equivalent standard SGML entities, or ISO 8859-n characters if available.
Ooddf ooting
Ooddheading
Unsupported. May be used inside the texinfo element.
@option{option-name}
<option>option-name</option>
©page <page>
Opagesizes [width] [, height]
Unsupported.
Oparagraphindent indent
Unsupported.
Opindex entry
<pindex entry= " entry ">
@point{} fepoint;
Spounds-Q
Use equivalent standard SGML entities, or ISO 8859-n characters if available.
@print{} feprint;
©print index index-name
<print index name= " index-entry ">
Opxref {node-name, [entry], [topic-or-title] , [info-file] , [manual]}
<pxref id="node-name " name="entry " title="topic-or-title "
inf o=" info-file " ptitle="manual ">
©quest iondown{}
Use equivalent standard SGML entities, or ISO 8859-n characters if available.
©quotation
<quotation>
in-line
</quotation>
Chapter 15: Supported and unsupported Texinfo feature
55
@r{text} <roman>text</roman>
Oraisesections
Unsupported.
Or ef {node -name, [entry], [topic-or-title], [info-file], [manual]}
<ref id= "node -name " name=" entry" title=" topic-or-title "
inf o=" info-file " ptitle="manual ">
©refill Unsupported.
@result{}
&result ;
@ringaccent{c}
Use equivalent standard SGML entities, or ISO 8859-n characters if available.
0 samp {text}
<samp>text </samp>
@sc{text}
<sc>text</sc>
©section title
<h2>title</h2>
©set flag string
Unsupported. May be used inside the texinfo element.
Osetchapternewpage on-off-odd
<setchapternewpage content="on-off-odd">, or use command line option:
' — set chapternewpage=on-off -odd'.
Osetcontentsaf tertitlepage
Unsupported.
@setf ilename inf o- file-name
<setf ilename content=" inf o- file-name ">
@set short content saftert it lepage
Unsupported.
Osettitle title
<settitle content=" title ">
©short contents
< short c ont ent s >
Oshorttitlepage title
Unsupported.
Osmallbook
Use command line option: ' — paper=small'.
Osmalldisplay
<smalldisplay> text -block</ smalldisplay>
Chapter 15: Supported and unsupported Texinfo feature
56
Osmallexample
<smallexample>
block
</ smallexample>
Preformatted:
<smallexample>
<pre>
in-line
</pre>
</ smallexample>
literal:
<smallexample>
<pre>
< ! [CDATA [
©smallf ormat
literal
Osmalllisp
in-line
]]>
</pre>
</ smallexample>
<smallf ormat>
<pre>
</pre>
</ smallf ormat>
<smallf ormat>
<pre>
< ! [CDATA [
]]>
</pre>
</ smallf ormat>
<smalllisp>
block
Chapter 15: Supported and unsupported Texinfo feature
57
</ smalllisp>
Preformatted:
<smalllisp>
<pre>
in-line
</pre>
</ smalllisp>
literal:
<smalllisp>
<pre>
< ! [CDATA [
in-line
]]>
</pre>
</ smalllisp>
@sp lines
<sp lines="2ines ">
@ss{} Use equivalent standard SGML entities, or ISO 8859-n characters if available.
@strong{text}
<strong>text</strong>
©subheading title
<h3 type="heading">title</h3>
©subsection title
<h3>title</h3>
Osubsubheading title
<M type="heading">title</h4>
Osubsubsection title
<h4>title</h4>
©subtitle subtitle
<subtitle>subtitle</ subtitle>
Osummarycontents
<sununarycontents>
Osyncodeindex from-index into-index
<syncodeindex from=" from-index" to=" into-index ">
Osynindex from-index into-index
<synindex from=" from-index" to=" into-index ">
@t{text } <typewriter>text </typewriter>
Chapter 15: Supported and unsupported Texinfo feature
5*
Stab See Omultitable.
Stable formatting— command
<table emphasis=" command ">
<item>descriptive-item</ item>
[<itemx>descriptive-item</itemx>] . . .
text-block. . .
<item>descriptive-ite2n</ item>
[<itemx>descriptive-item</itemx>] . . .
text-block. . .
</table>
OTeXO &TeX;
@tex <tex>tex_back_end_code</tex>
Othis chapter
Othis chaptername
Othisfile
Othispage
Othistitle
Unsupported. May be used inside the texinfo element.
Otie-Q fenbsp;
Otieaccent {cc}
Unsupported. 2
@t index entry
<t index entry= " entry ">
©title title
<title>title</title>
@titlefont{text}
Unsupported.
Otitlepage
Unsupported. See Sgmltexi structure,
©today fetoday;
Stop Generated automatically; in other words, it is hidden to the user.
@u{c>
@ubaraccent{c}
Oudot ac c ent { c }
Unsupported. 3
2 Is there a standard SGML entity? I need advice.
3 Are there standard SGML entities? I need advice.
Chapter 15: Supported and unsupported Texinfo feature
©unnumbered title
<hl type= "unnumbered" >ti tie </hl>
Ounnumberedsec title
<h2 type="unnumbered">title</h2>
©unnumberedsubsec title
<h3 type= "unnumbered" >title</h3>
@unnumberedsubsubsec title
<h4 type= "unnumbered" > title </h4>
Ouref {url, [displayed-text] , [replacement] ]-
<uref uri="url" name="displayed-text " replace= " replacement '
Our 1{ url }
<url>url </url>
@v{c} Unsupported. 4
@value{f lag}
Unsupported. May be used inside the texinfo element.
@var{metasyntactic-variable}
<var>metasyntactic-variable</var>
@verb{x 1 i t eral_ t ext x }
<verb char="x"><! [CDATA [literal_text] ] ></verb>
©verbatim literal_text Send verbatim
<verbatim>
< [CDATA [
literal_text
]]>
</verbatim>
Overbatiminclude file
<verbatiminclude file="file">
Ovindex entry
<vindex entry= " entry ">
Ovskip amount
Unsupported. May be used inside the texinfo element.
Ovtable formatting— command
<vtable emphasis=" command ">
<item>descriptive-item</ item>
[<itemx>descriptive-item</itemx>] . . .
text-block. . .
<item>descriptive-item</ item>
4 Are there standard SGML entities? I need advice.
Chapter 15: Supported and unsupported Texinfo feature
60
[<itemx>descriptive-item</itemx>] . . .
text-block. . .
</vtable>
@w{text} <whole>text</whole>
Oxref {node-name, [entry], [topic-or-title] , [info-file], [manual]}
<xref id="node-name " name="entry" title=" topic-or-title "
inf o=" info-file " ptitle="manual ">
Appendix A: Supported ISOnum entities: numeric and special graphic
Appendix A Supported ISOnum entities:
numeric and special graphic
The following table shows the current state of supported ISOnum entities.
SGML macro Appearing
1 iocpyinfinii
OGlldll}
TV ° c\ ion nnp-nnlr
11 CXK'hWjLi. lldll
&fracl2
1/2
TV £1 c\ 1 ATI f\ ~T\ £3 HQ T
11 dC L1U11 UllC lldll
&fracl4
1/4
fraction one-quarter
¾
3/4
fraction three-quarters
&fracl8
1/8
tv o pt ihti r\~T\c± pi rrht h
11 dCLilUll Ullc-clgllLll
&frac38
3/8
fraction three-eighths
&frac58
5/8
TV Q f't Tl ~\T£* PI (T M T he
11 dC L1U11 11 VC-t?lRllLllo
&frac78
7/8
iidCiioii se ven-eigiiiiis
&supl;
[supl ]
Oil T"\ / \ T L ' / * 1 ' 1 TAT" /" \ > \ / \
supeiscupi one
²
[sup2 ]
s upei sci ip i Lwu
³
[sup3 ]
superscript three
+
+
pius sign
± +/ —
n no rw tyi mnc ci on
piLlo UI llllllLlo oltill
<
<
less-than sign
&equals
cL[Udlo olgll
>
>
rr t* o o i o t i~ ri o n en mi
gi eaiei- Liian sign
÷
[divide]
divide sign
×
[times ]
multiply sign
¤
; [curren]
rr en ti o T* o 1 r-n t t c\ t~\ c~\t en mi
gciiciai cunency sign
£ £
pound sign
$
$
LLUliai olgll
¢
[cent ]
cent sign
¥
[yen ]
yen sign
fenum;
#
number sign
&percnt
; %
percent sign
feamp;
ampersand
*
*
OCT TO 7
as Lei isk
fecommat; @
commercial at
Msqb;
[
left square bracket
\
\
reverse solidus
]
]
right square bracket
{
{
iei i c ui ly ui acKe i
― [horbar]
horizontal bar
&verbar
; 1
vertical bar
}
}
right curly bracket
µ
[micro ]
micro sign
Ω
[ohm ]
ohm sign
°
[deg ]
degree sign
º
[ordm ]
ordinal indicator, masculine
ª
[ordf ]
ordinal indicator, feminine
§
[sect ]
section sign
¶
[para ]
pilcrow (paragraph sign)
· •
middle dot
Appendix A: Supported ISOnum entities: numeric and special graph
OoldJ. I j
Harr 1
1 Lai L 1
fitt'WT'Q V r 1 Q TTTTfWHT
ICl Li W dl LL dl IUW
OCl Cll 1 .
1 ai 1 1
vi crnt"(xm vn ° tttyia/
1 1 till L W dl LL dl IUW
↑
[uarr ]
upward, arrow
&dari"
[uai 1 j
QOWllWcllLL clllOW
•^copy,
copyngni sign
aVv^ct"
661 eg,
l le 6 J
t*octi ct c» v p> H cicrn
1 C^lo Lt-1 CLL Dlg,ll
A7"l~ VC1 H
06 LI ClLlC,
t vo rlf*
LI dLLL-
tvcin£» vnnvk" cio" n
LI dLLC llldl JS. Dltill
at" rvr*"\7' r\ci v *
OO IJl V Udl ;
hvir rsa v
1 Ul V Udl 1
nTnVpTi 1 \r£»vti pci 1 1 r\civ
Ul UJ\cll t VCl LIL/dl ) Udl
¬
[not ]
not sign
♪
[sung j
music note (sung text sign)
&exclj
|
exclamation mark
OOlC-AAjl.
i
lilVCl LCLl C-X-CldllldLltJll llldl JS.
A/nnnf •
ocuuu L ;
11
nnntfltinri vnavK
LJ LIU Ld L1LJ11 lllcll IS.
occipOb,
>
aposxi op xic
felpar;
I
1
left parenthesis
ferpcirj
)
right parenthesis
66 L/U 11 111 Id,
i
L,Ulllllld
OolUW Udl ;
IUW 11 11C
Oollj' JJ11C11 .
n vv* nf^vi
ii^y jjiicii
A7"nprinn •
06 JJC1 1U LI .
full ctnn nPTinn
1 LAll O LL/ U, jJt-1 1LJL1
/
/
t:nl i r\ n q
OUllLL U.O
06L/LJHJ11,
LAJ1VJ11
Ooodlll,
3
o Cj 11 1 1 LjLJ L\J 11
OCA ] I LL 0 I. ,
?
rmpctinn vytcivIt
L|LLCO L1LJ11 lllcll IS.
Ann 1 1 f^cf •
061LJ Llt-O L ;
I
i Tv\rfiVTP>n mipotinn incivk"
111VC1 LCLl L^LlCoLlLJll lllcll iS.
A7l flmift'
OoldLJ UAJ .
nnun
ICX^LIU 1
° vi crl p n not ° f l nn m ° v k 1 f^ft
Clll&jlC LJ UvJ L CI L1LJ11 lllCll IV . Id L
»
[raquo ]
angle quotation mark, right
Msquo;
[lsquo ]
single quotation mark, left
fersquo;
[rsquo ]
single quotation mark, right
Mdquo;
[ldquo ]
double quotation mark, left
”
[rdquo ]
double quotation mark, right
no break (required) space
[shy ]
soft hyphen
Appendix B: Supported ISOpub entities: publishing
Appendix B Supported ISOpub entities:
publishing
The following table shows the current state of supported ISOpub entities.
SGML macro Appearing
i/cotl 1JJL1U11
OTY1 C T~\ Q f~» O
eill bpdCc
[ensp ]
eil spdce i z-emj
&emspl3; [emsp3 ]
1 / o-fc;lll SpdCc
&emspl4; [emsp4 ]
1 / -^i-eill SpdCc
  [numsp ]
digit spdce (width of d number)
  [puncsp]
punctudtion spdce (width of cornmd)
[thinsp]
thin spdce (1/6-em)
cfchairsp; [hairsp]
hdir spdce
ociilCldSL
j [lllQdbll J
em ddsh
V T Ti f~\ O C 1 Y~i •
ooIlQdSn,
[iiQasn j
en ddsh
‐
[dash ]
hyphen (true grdphic)
␣
[blank ]
sigmiicani uiaiiK symuoi
…
[hellip]
ellipsis (horizontal)
‥
[nldr ]
double baseline dot (en leader)
&fracl3
1/3
lldCUUll Ullc- lllll U.
&frac23
2/3
frdction two-thirds
&fracl5
1/5
frdction one-fifth
&frac25
2/5
frdction two-fifths
&frac35
3/5
frdction three-fifths
&frac45
4/5
frdction four-fifths
&fracl6
1/6
lldCUOll OilfcJ-MXlll
&frac56
5/6
tt* o c\ 1 r\~T\ Tl ~\T£* Gl "V"t" h G
11 at L1U11 11 Vc _ o1a Lllo
feincare
[incare]
111-L.dl fcJ-Ol SyillUUl
█
[block ]
full hlork
1U.11 UlULA.
▀
[uhblk ]
1 1 T~\ T"^ r\ T* no T r~\ 1 f~\ f~~* XT'
uppei nan oiock
felhblk;
[lhblk ]
r~\\\Tt^T hp T \ \ c u
1UWC1 ildll U1ULJ\.
&blkl4;
[blkl4 ]
Zo/o snauea DlocK
&blkl2;
[blkl2 ]
ou/o sndueci DIOCK
▓
[blk34 ]
1 O /0 SildLieQ U1UCK
▮ [marker]
histogram marker
○
[cir ]
circle, open
□
[squ ]
square, open
▭
[rect ]
iecLdii^ie, ujjeii
▵
[utri ]
up triangle, open
▿
[dtri ]
down triangle, open
☆
[star ]
star, open
•
•
round bullet, filled
▪
[squf ]
sq bullet, filled
▴
[utrif ]
up tri, filled
fedtrif;
[dtrif ]
dn tri, filled
feltrif;
[ltrif ]
1 tri, filled
fertrif;
[rtrif ]
r tri, filled
♣
[clubs ]
club suit symbol
Appendix B: Supported ISOpub entities: publishing
64
<36LLldlllb,
[Llldlllb J
LLldlllOllU. SUIL symuoi
ocllcdl to,
lllcdl Lol
n pa t*t en l t c\7"rn h\Pi
llCdl t oU.lL oVlllL-'Ul
♠
[spades]
spades suit symbol
A t wi o 1 T ■
OGllldll ,
[malt ]
m o 1 toco r'Tnc c
llldlLcoc CiUoo
<v,udggei ,
[Udggeij
H pi n'ffPT 1
6£.uaggei ,
1 ) o (T rrpi 1
L- Ud &6 el J
LLvJUUlC (.IdggLi
A tc n Pf 1 u' *
ooUllcUK,
1 CllcCA. I
'l"ir i U' Prippb - TYl Q T" U~
LIUIS., LllCLlS. llldl Iv
Ool^l Uuo .
ballotl
UCL±l\J b
nail of r'votit;
Arc nor t \ ■
GCblldl p,
oho VTA
[Slldip J
lllUolCdl olldip
oclldL,
flat 1
lid Li
lllUolLdl lldL
A7"m a 1 p*
OGllldlC,
TTl a 1 P
llldlt;
TTl flip tn/TYT r\(~ll
& female 5
[female]
female symbol
V T~\~\ V~i /^fc TA /~\ •
otspnoiie ,
[pnone j
teiepiiOiie oymooi
a 7"t P vp/" 1 *
fn rpp
1 Lull UU 1
LClcpilUllt: lt:CUlU.cl ojlllUUl
℗
[copysr]
sound recording copyright sign
⁁
[caret ]
caret (insertion mark)
‚
[lsquor]
rising single quote, left (low)
<Y,lCLqUOI ,
[lCLC[UOI J
iibiiig qui quoLe, leu (iowi
Oollllg, •
tti fi 1 1 TT 1 1 cratn t*p
lllCXll 11 lleiCl b Ul C
Oollllg ;
TTI CI 1 1 TT licrci'fn'rp
llldll 11 llgdLUlC
a£I J u B)
filic 1
TTI Q Tl lfffltllTP
llldll 1J ll^dLUlc
0611111^, .
ffilip-1
TTl CI 1 1 TTl llCTCl'flTrP
llldll 111 ll^dlUlC
ocmiig,
Pffllicr
[mngj
iiidii ill iigdLuie
[Alia 1
m oil T1 In iTfilnTn
iiidii ii n^diuie
A 7 TTl M T* *
061111U.1 .
in Lit
llllt.il
TTl Pd/lPT*
111 lt:dU.t:l
oil QCJUOI ,
[1 UqUOl J
using qui quoie, iigni ^mgnj
’
[rsquor]
rising single quote, right (high)
V r ~t rr\ 1 1 1 ■
o6 venip,
[venipj
vei Licdi eiiipsio
Mivhiill-
hvbnlll
111*/ UU11J
rpptnncflp Tillprr / nvnnpn rvnllpl" 1
1 Ct L dllg,lt; , 1111CU. lllJ/JJllCll UU11C-L J
OgIUZj .
1(17 1
L J
lo^PTicrp — lri^PTicrp nr total tm9Tk
1\JZj\311&.C HJZjC'II&.C' Ul uUl dl lllCll IS.
6Z10ZI,
[J.OZI J
blacklozenge - lozenge, filled
o61tl 1,
ll til 1
t T"l Q Yl (T P HTIPTI
1 Llldll^lt:, Upcll
OOl LI 1 ■
[rtri ]
v t rid ti crl p rinPTi
1 LI IClll^jlC, UJJC11
OoO UOil ± 5
GtaVT
O L dl 1
ni crt:t a r — t;t a r ti 11 pn
UlgOLeXl OLCLl, llllCvl
(VTlfl tllT *
KJCi-L-LtAi V Ul .
matiiT" 1
natural - mnsir natnval
℞
[rx ]
pharmaceutical prescription (Rx
✶
[sext ]
sextile (6-pointed star)
⌖
[target]
register mark or target
fcdlcrop;
[dlcrop]
downward left crop mark
fedrcrop;
[drcrop]
downward right crop mark
⌏
[ulcrop]
upward left crop mark
⌎
[urcrop]
upward right crop mark
Appendix C: Supported ISOtech entities: general technical
65
Appendix C Supported ISOtech entities: general
technical
The following table shows the current state of supported ISOtech entities.
Ljvrlvllj lUdtl U
Ut3oCI lpilOil
06 die JJ 11,
Idlcpil 1
O 1 on rl 1 — 1 O r"\ VQTTT
diepil, JlcUlcW
&and^
[and ]
lOglCdl dllll
&;angyu,
[dng90 ]
right (90 degree) dngle
ocdllgspil,
[angspnj
angie-spnei icai
≈
[ap ]
approximate
∵
[becaus]
because
⊥
[bottom]
perpendicular
&cdp5
[cap ]
1T1T AT'n nnr inn
lllLcl beCLlUll
ocCOIlg,
[cong j
rfvi T A"nT 11 TIT" r~\
congi uenc wini
,V T C* f~\ n 1 TIT •
06COI11I11,
C i~\ Yl 1 TIT
[COI11I11J
conioui iine^i di upeidLui
∪
[cup ]
union or logicdl sum
o^equiv,
ItieilLlCdl W1LI1
1 C-A.IO I 1
P.T l^Pltll" f~\Y\£* £i"V"l OT C
AVfrvrall-
oiioran,
[fordll]
for dll
061I1U1,
ffnnf 1
[IIIOI J
fi i n nfi /~\ n nf 1 iro n/ 1 c m oil t 1
lUIlCllOIl Ol 1 lldllC ollldll 1 1
≥
fe e ]
greater-than-or-equal
06111,
[iff 1
[in j
it 0 n rl nn 17 it
11 dllLl Ulll V 11
∞
[infin ]
infinity
6£inc,
[lilt J
integral operator
&ism5
[ism ]
GOT TT1 O ITl Kdt'C rl 1 T~\
&C L lllclll Ucl olll U
17 QTIIV"
ociaiig,
[rang j
1 QTT QUIT Q nTQ^LrDT
lei L dll^ie Ul dCKfc: I
MArr-
h A it 1
lo lIlipilcQ uy
ooie,
He 1
[ie j
Icoo - tlldll - 01 - t:L[U.dl
a t in l mi q *
TTl 1 Till G G 1 (Til
111111 LIB oltill
∓
r 1 1
[mnplus]
minus-or-plus sign
ooiiauia,
iiiauia 1
rlfi Mo TY1 1 1 ifWl r^T~\OTCl T nT
LLtJl. ndlllllLUll UpcldLOl
≠
[ne ]
not equal
&:ni,
[ni ]
contains
∨
[or ]
logical or
∥
[par ]
parallel
∂
[part ]
partial differential
ocpeiiiiii,
[peilllllj
pei LiiuusaiiQ
ocpeip,
T\C*T*T\
[peip j
pei penu.ic uiai
′
[prime ]
prime or minute
″
[Prime ]
double prime or second
∝
[prop ]
is proportional to
√
[radic ]
radical
〉
[rang ]
right angle bracket
&;rArr;
[rArr ]
implies
∼
[sim ]
similar
≃
[sime ]
similar, equals
□
[square]
square
⊂
[sub ]
subset or is implied by
Appendix C: Supported ISOtech entities: general technical
A 7"C1 1 Kp"
OooUUc,
cj n ri
loUUc 1
on r^Gfi'i" onn a 1 g
oUUocL, CL^Ucxlb
⊃
[sup ]
superset or implies
66b Upe,
[blipe J
oiinflyooT anno c
s upei se l , et^udib
Oo IjllCl C-t: ;
fthoro4l
L11L1 L--±
L1J.C1 ClUl c
At" Vpt r*£l T* •
OO V CI UCll ;
1 V CI U&l 1
fir\l ^t^tti r*a 1 hav
oiangsr,
[angst ]
capital A, ring
a 7" horn i •
66 UeillUU,
[UeiilOUJ
UeillUUlll lUllcLlUIl IbCiipi cdpilcll H> J
(X/LU lilJJ 111 ;
c> r\ ryi T~\ f "n
CU111JJ111 1
pnTYi nncii "ft* fnn^tinn / email pitt'I^m
Mint-
Dnt 1
\-J\)\
niprpcio nr nmlimt TnaTk"
VJ.1C1 Colo VJ1 LlllllCtLlL lilcXl IS.
06U0IU0I,
\Wc\W\c\V\
[UOIUOIJ
ioui Quib duove
A7" n PI TTI 1 It" "
GollCtlllll Li •
n P TYT 1 1 T
licxiilli L
n a in 1 Itnn 1 a n i cpvirit r i aT\i1~al H 1
Aria crrpri •
1 f\ pra n
J-CXgji CLil
1 a pra n cn an (^rri'nt ranital Til
Mowast;
[lowast]
low asterisk
∉
[notin ]
negated set membership
ℴ
[order ]
order of (script small o)
ℳ
[phmmat]
physics M-matrix (script capital M)
fetdot;
[tdot ]
three dots above
‴
[tprime]
triple prime
≙
[wedgeq]
corresponds to (wedge, equals)
Appendix D: Supported ISOlatl entities: added latin 1
Appendix D Supported ISOlatl entities: added
latin 1
The following table shows the current state of supported ISOlatl entities.
lj\j1V11j lUdtl U
dipped! nig
LIKSLI lpilOIl
á
a
small a, acute accent
Á
A
capital A, acute accent
06dClI 0,
a
smaii a, ciicumnex accem
XT A C 1 T" C '
<36-T\-Cll (_.,
A
0 t~\ 1 t 0. 1 A pivpnTYi'nQV 0 r* pon 1
capnai ii. en cuiniiex accein
à
a
small a, grave accent
X T f\ rV TOT T •
o6-figiave,
A
capital A, grave accent
å
a
small a, ring
A
/\
capnai .tl, ^n.i&
&jatiiue,
a
small a, tilde
66-firnue,
capital A, tilde
ä
a
small a, dieresis or umlaut mark
06-TlUIlU,
A
capnai .ri, meiesis 01 umiaui mdiK
cfcaelig;
ac
small ae diphthong (ligature)
jCr A "Plirr-
capital AE diphthong (ligature)
ç
Q
small c, cedilla
oi^ceuu,
capital C, cedilla
oiern,
[ern j
small eth, Icelandic
f,T?TU-
[Jiln |
capital Eth, Icelandic
é
c
small e, acute accent
ocH/acuie,
tr
i .
f~~* O T~\ 1 TO In O PUT O f~~* f~~*n T~i T
capnai H/, acute accent
ê
c
small e, circumflex accent
(KIIjCIIC,
pi
capital E, circumflex accent
è
C
small e, grave accent
È
11
capital E, grave accent
ë
c
small e, dieresis or umlaut mark
f,p lira i.
<36rjUiiii,
f?
capnai jUj, tueiesis ui umiauL maiK
í
i
small i, acute accent
Í
f
1
capital I, acute accent
î
i
small i, circumflex accent
Î
f
1
capital I, circumflex accent
ì
1
small i, grave accent
Ì
t
1
capital I, grave accent
ifeiumi;
i
small i, dieresis or umlaut mark
Ï
i
capital I, dieresis or umlaut mark
ñ
11
small n, tilde
feNtilde;
N
capital N, tilde
ó
6
small o, acute accent
Ó
6
capital 0, acute accent
ô
0
small o, circumflex accent
Ô
6
capital 0, circumflex accent
ò
6
small o, grave accent
Ò
6
capital 0, grave accent
ø
0
small o, slash
Appendix D: Supported ISOlatl entities: added latin 1
OiUoldall,
Cdpildl \J , Sldoll
oioiuQe,
0
small o, "tilde
oi^jinae,
capital 0, tilde
ö
0
small o, dieresis or umlaut mark
frAllTTll-
Cdpildl \J . UieieSlS Ol UlllldUL illdlK
oiszng,
R
small sharp s, German (sz ligature)
þ
[thorn ]
small thorn, Icelandic
fTTIDPM 1
capirai i riL/ixiN , iceiaiiQic
ITll o /lilt £i ■
oiuacute,
U
smaii u, acuxe accent
o6 u acute,
TT
u
C O T~\1 TO 1 O PIT 1 D O CT'd 1~\ T
cdpiidi U; dcuie accent
û
U
small u, circumflex accent
OO *J Cli C,
TT
U
C* O, T~\l 1" O, 1 P1TP11 TT1 Tl f>'V or 1 /"•Cm'f"
l^dpi Lai \J ; C1I UIlllltJA. dUCCLlL
ù
U
small u, grave accent
Ù
U
capital U, grave accent
ü
ii
small u, dieresis or umlaut mark
Ü
U
capital U, dieresis or umlaut mark
ý
y
small y, acute accent
Ý
Y
capital Y, acute accent
fcyuml;
y
small y, dieresis or umlaut mark
Appendix E: Supported IS01at2 entities: added latin 2
Appendix E Supported IS01at2 entities: added
latin 2
The following table shows the current state of supported IS01at2 entities.
/i-Ppedl lllg
LIKSLl lpilOIl
& abreve;
[abreve]
small a, breve
Ă
[Abreve]
capital A, breve
& amacr;
[amacr ]
small a, macron
&Amacr ;
[Amacr ]
capital A, macron
& aogon;
[aogon ]
small a, ogonek
Ą
[Aogon j
capital A, ogonek
ć
c
small c, acute accent
ooV-^dL/ULe,
p
CdJJlldl v_>, atUtc decent
č
[ccaron]
small c, caron
[V^CdlOIlJ
capnai 0, Ccxi 011
ĉ
C
small c, circumflex accent
ATI r'TYT' •
G6 V^Cli C,
C
cdpiidi v_^ ; en cuiiine-x. decent
6£CCLOT,
c
small c, dot above
(36 LIU L ,
c
V
cdpiidi v^>, U.UL duove
& dear on;
[dcaron]
small d, caron
AT" 1 lr ) tlY'i~W~l •
06 LJ Cell Ull,
Cell (Jill
CdJJl Li dl -L/ . l/dl Oil
đ
small d, stroke
6£USTTOK,
[ustroKj
capital D, stroke
ocecai 011,
[ecai onj
smaii e, caion
Ě
[Ecaron]
capital E, caron
oieuox,
c
small e, dot above
06-CjQor,
capital E, dot above
ē
[emacr ]
small e, macron
06-CJmacr,
[Hjiiiacr j
capital E, macron
ę
[eogon ]
small e, ogonek
Ę
[Eogon ]
capital E, ogonek
ǵ
g
small g, acute accent
ğ
[gbreve]
small g, breve
& Gbr eve 5
Drevej
capital G, breve
oc^jceoii,
P
V
cdpiidi \jt, cecuiid
ĝ
s
small g, circumflex accent
OC^jrCll C,
P
capiidi ^j, en c umiiex accent
ollldll LLUL dUUVc
Ġ
G
capital G, dot above
ĥ
h
small h, circumflex accent
Ĥ
H
capital H, circumflex accent
ħ
[hstrok]
small h, stroke
Ħ
capital H, stroke
Mdot;
i
capital I, dot above
Ī
[Imacr ]
capital I, macron
ī
[imacr ]
small i, macron
ij
[ijlig ]
small ij ligature
MJlig;
[IJlig ]
capital IJ ligature
Appendix E: Supported IS01at2 entities: added latin 2
ı
[inodot]
į
[iogon ]
JXOgOIl J
J^itilde-
ft-TtilHp-
Ool lJ.HJ.t3 5
f
Xr\f\rf •
OoJ KjlL .
i
J a
AT" I OTTO"
T
0
X^kredil-
k
A>TOpdil-
K
^kfrrppTi '
OcldCUlje,
1
l
Ĺ
T
ľ
[ICdl OI1J
Ľ
[Lcdron]
eziceun,
1
1
oi-L/ceuii,
Lj
XVItyi i Hot ■
1 in 1 n of
aVT iTTI 1 n of •
T ,Tn 1 n of
ł
1
1
oZIjSXIOK,
T
Lj
ń
ii
oiiN acuce,
Kt
In
ŋ
[eng ]
ʼn
[napos j
OoIlCdlOIl,
[IlCdl OI1J
66-LN Cdl Oil,
[In Cdl OI1J
ooIlCcQll,
11
66 IN CcQll,
In
A7on nl a r* •
OoVJU. VjLCXKj}
ci
u
<36V^ClDldC,
Vt| 1 ryi t* •
o6L/iiiaci ,
I 1 T~Y"1 O /"* "V
[wiiiaci j
&omacr ;
[omacr ]
œ
CC
06^-tL/ng,
&r acute;
f
66r\dCUIc,
n
<36l Cdl Oil,
[I CdlOIlJ
at" 1^ 0 T*rvn •
Y\ 0 3 t c\ n
ŗ
r
Ŗ
?
ś
s
Ś
S
š
[scaron]
Š
[Scaron]
fescedil;
§
small i without dot
small i, ogonek
capital I, ogonek
small i, tilde
capital I, tilde
small j , circumflex accent
capital J, circumflex accent
small k, cedilla
capital K, cedilla
small k, Greenlandic
small 1, acute accent
capital L, acute accent
small 1, caron
capital L, caron
small 1, cedilla
capital L, cedilla
small 1, middle dot
capital L, middle dot
small 1, stroke
capital L, stroke
small n, acute accent
capital N, acute accent
small eng, Lapp
capital ENG, Lapp
small n, apostrophe
small n, caron
capital N, caron
small n, cedilla
capital N, cedilla
small o, double acute accent
capital 0, double acute accent
capital 0, macron
small o, macron
small oe ligature
capital OE ligature
small r, acute accent
capital R, acute accent
small r, caron
capital R, caron
small r, cedilla
capital R, cedilla
small s, acute accent
capital S, acute accent
small s, caron
capital S, caron
small s, cedilla
Appendix E: Supported IS01at2 entities: added latin 2
<v:oceaii,
capital S, cedilla
66OCII C,
s
Ollldll o, CllCUllllieX dCCeill
Ŝ
0
Cdpildl 0, CnCUmneX dCCcilX
06 lUdl Ull,
c in qI t" r* q t*o n
Ollldll I ; Lai Ull
Ť
[Tcaron]
capital T, caron
tim 1 1 t rr>rl 1 1 1
&i 1 ceuu,
T
±
capital T, cedilla
06 loll UK,
C TYI oil T CTT T*/~» L'O
Ollldll 1, 0 Ll UKc
66 1 STIOK,
[ 1 STiOKJ
capital T, stroke
1 1 Ktqi t a
[iiui evci
c tyi oil it r~\ t*o t rn
Ollldll U 5 ui e Vfc:
Ŭ
[Ubreve]
capital U, breve
A 7" 1 1 (H K OP'
66 ULlUldC,
11
C YV1 oil 11 (H /~k 1 1 r"\ 1 O Q T' IT T Q O /*>/*>OTTf"
Ollldll U, LlUUUlt; dCU.lt; dCCeill
66 U CLDiaC,
t"t
u
capital U, double acute accent
V 7" 1 1 T~Y"~1 O 1"* •
ocuniaci ,
[umaci j
O T\ 1 oil 11 1 1 1 O /"'TV \ "1 ^
Ollldll U, llldCl Oil
& Umacr 5
[Umacr ]
capital U, macron
& uogon;
[uogon ]
small u, ogonek
66 UOgOll,
[ uogon j
capiidi u, ogoneK
66Uilll£2 ) ,
u
c 1 tvi oil ii v l Yi rv
ollldll U, 1 11I3
66 Ullllg,
TT
U
f~~* O T"\l TO 1 T* 1 T~\ fT
Cdpildl U, illlg
£ r n t i 1 rl 0 •
66uniae,
u
small u, tilde
66 UX11Q6,
TT
u
O T"\ l T O 1 1 Til /~\
capnai u, nioe
ŵ
w
small w, circumflex accent
66 VV Cll C,
w
V V
cdpiidi vv 5 en c umiiex dcceni
ŷ
y
small y, circumflex accent
66 1 Ull
Y
Udpildl i . Cll Kj LlillllcA. dUCClll
Ÿ
Y
capital Y, dieresis or umlaut mark
ź
z
small z, acute accent
&Z acute;
Z
capital Z, acute accent
ž
[zcaron]
small z, caron
Ž
[Zcaron]
capital Z, caron
ż
z
small z, dot above
Ż
Z
capital Z, dot above
GNU Free Documentation License
72
GNU Free Documentation License
Version 1.1, March 2000
Copyright © 2000 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other written docu-
ment "free" in the sense of freedom: to assure everyone the effective freedom to copy and
redistribute it, with or without modifying it, either commercially or noncommercially. Sec-
ondarily, this License preserves for the author and publisher a way to get credit for their
work, while not being considered responsible for modifications made by others.
This License is a kind of "copy left", which means that derivative works of the document
must themselves be free in the same sense. It complements the GNU General Public License,
which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free
software needs free documentation: a free program should come with manuals providing the
same freedoms that the software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or whether it is published
as a printed book. We recommend this License principally for works whose purpose is
instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work that contains a notice placed by
the copyright holder saying it can be distributed under the terms of this License. The
"Document", below, refers to any such manual or work. Any member of the public is a
licensee, and is addressed as "you".
A "Modified Version" of the Document means any work containing the Document or a
portion of it, either copied verbatim, or with modifications and/or translated into another
language.
A "Secondary Section" is a named appendix or a front-matter section of the Document
that deals exclusively with the relationship of the publishers or authors of the Document to
the Document's overall subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (For example, if the Document is in part a textbook
of mathematics, a Secondary Section may not explain any mathematics.) The relationship
could be a matter of historical connection with the subject or with related matters, or of
legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as
being those of Invariant Sections, in the notice that says that the Document is released
under this License.
GNU Free Documentation License
73
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover
Texts or Back-Cover Texts, in the notice that says that the Document is released under this
License.
A "Transparent" copy of the Document means a machine-readable copy, represented in
a format whose specification is available to the general public, whose contents can be viewed
and edited directly and straightforwardly with generic text editors or (for images composed
of pixels) generic paint programs or (for drawings) some widely available drawing editor,
and that is suitable for input to text formatters or for automatic translation to a variety of
formats suitable for input to text formatters. A copy made in an otherwise Transparent file
format whose markup has been designed to thwart or discourage subsequent modification
by readers is not Transparent. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without
markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly
available DTD, and standard-conforming simple HTML designed for human modification.
Opaque formats include PostScript, PDF, proprietary formats that can be read and edited
only by proprietary word processors, SGML or XML for which the DTD and/or processing
tools are not generally available, and the machine-generated HTML produced by some
word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following
pages as are needed to hold, legibly, the material this License requires to appear in the title
page. For works in formats which do not have any title page as such, "Title Page" means
the text near the most prominent appearance of the work's title, preceding the beginning
of the body of the text.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or
noncommercially, provided that this License, the copyright notices, and the license notice
saying this License applies to the Document are reproduced in all copies, and that you
add no other conditions whatsoever to those of this License. You may not use technical
measures to obstruct or control the reading or further copying of the copies you make or
distribute. However, you may accept compensation in exchange for copies. If you distribute
a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly
display copies.
3. COPYING IN QUANTITY
If you publish printed copies of the Document numbering more than 100, and the Doc-
ument's license notice requires Cover Texts, you must enclose the copies in covers that
carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and
Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you
as the publisher of these copies. The front cover must present the full title with all words
of the title equally prominent and visible. You may add other material on the covers in
addition. Copying with changes limited to the covers, as long as they preserve the title of
GNU Free Documentation License
74
the Document and satisfy these conditions, can be treated as verbatim copying in other
respects.
If the required texts for either cover are too voluminous to fit legibly, you should put
the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest
onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100,
you must either include a machine-readable Transparent copy along with each Opaque
copy, or state in or with each Opaque copy a publicly-accessible computer-network location
containing a complete Transparent copy of the Document, free of added material, which
the general network-using public has access to download anonymously at no charge using
public-standard network protocols. If you use the latter option, you must take reasonably
prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that
this Transparent copy will remain thus accessible at the stated location until at least one
year after the last time you distribute an Opaque copy (directly or through your agents or
retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well
before redistributing any large number of copies, to give them a chance to provide you with
an updated version of the Document.
4. MODIFICATIONS
You may copy and distribute a Modified Version of the Document under the conditions
of sections 2 and 3 above, provided that you release the Modified Version under precisely
this License, with the Modified Version filling the role of the Document, thus licensing
distribution and modification of the Modified Version to whoever possesses a copy of it. In
addition, you must do these things in the Modified Version:
• A. Use in the Title Page (and on the covers, if any) a title distinct from that of the
Document, and from those of previous versions (which should, if there were any, be
listed in the History section of the Document). You may use the same title as a previous
version if the original publisher of that version gives permission.
• B. List on the Title Page, as authors, one or more persons or entities responsible for
authorship of the modifications in the Modified Version, together with at least five of
the principal authors of the Document (all of its principal authors, if it has less than
five).
• C. State on the Title page the name of the publisher of the Modified Version, as the
publisher.
• D. Preserve all the copyright notices of the Document.
• E. Add an appropriate copyright notice for your modifications adjacent to the other
copyright notices.
• F. Include, immediately after the copyright notices, a license notice giving the public
permission to use the Modified Version under the terms of this License, in the form
shown in the Addendum below.
• G. Preserve in that license notice the full lists of Invariant Sections and required Cover
Texts given in the Document's license notice.
GNU Free Documentation License
75
• H. Include an unaltered copy of this License.
• I. Preserve the section entitled "History", and its title, and add to it an item stating at
least the title, year, new authors, and publisher of the Modified Version as given on the
Title Page. If there is no section entitled "History" in the Document, create one stating
the title, year, authors, and publisher of the Document as given on its Title Page, then
add an item describing the Modified Version as stated in the previous sentence.
• J. Preserve the network location, if any, given in the Document for public access to
a Transparent copy of the Document, and likewise the network locations given in the
Document for previous versions it was based on. These may be placed in the "History"
section. You may omit a network location for a work that was published at least four
years before the Document itself, or if the original publisher of the version it refers to
gives permission.
• K. In any section entitled "Acknowledgements" or "Dedications", preserve the section's
title, and preserve in the section all the substance and tone of each of the contributor
acknowledgements and/or dedications given therein.
• L. Preserve all the Invariant Sections of the Document, unaltered in their text and in
their titles. Section numbers or the equivalent are not considered part of the section
titles.
• M. Delete any section entitled "Endorsements". Such a section may not be included
in the Modified Version.
• N. Do not retitle any existing section as "Endorsements" or to conflict in title with
any Invariant Section.
If the Modified Version includes new front-matter sections or appendices that qualify as
Secondary Sections and contain no material copied from the Document, you may at your
option designate some or all of these sections as invariant. To do this, add their titles to
the list of Invariant Sections in the Modified Version's license notice. These titles must be
distinct from any other section titles.
You may add a section entitled "Endorsements", provided it contains nothing but en-
dorsements of your Modified Version by various parties-for example, statements of peer
review or that the text has been approved by an organization as the authoritative definition
of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up
to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified
Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added
by (or through arrangements made by) any one entity. If the Document already includes
a cover text for the same cover, previously added by you or by arrangement made by the
same entity you are acting on behalf of, you may not add another; but you may replace the
old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission
to use their names for publicity for or to assert or imply endorsement of any Modified
Version.
GNU Free Documentation License
76
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License,
under the terms defined in section 4 above for modified versions, provided that you include
in the combination all of the Invariant Sections of all of the original documents, unmodified,
and list them all as Invariant Sections of your combined work in its license notice.
The combined work need only contain one copy of this License, and multiple identical
Invariant Sections may be replaced with a single copy. If there are multiple Invariant
Sections with the same name but different contents, make the title of each such section
unique by adding at the end of it, in parentheses, the name of the original author or
publisher of that section if known, or else a unique number. Make the same adjustment to
the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections entitled "History" in the various
original documents, forming one section entitled "History"; likewise combine any sections
entitled "Acknowledgements", and any sections entitled "Dedications". You must delete
all sections entitled "Endorsements."
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released
under this License, and replace the individual copies of this License in the various documents
with a single copy that is included in the collection, provided that you follow the rules of
this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually
under this License, provided you insert a copy of this License into the extracted document,
and follow this License in all other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent
documents or works, in or on a volume of a storage or distribution medium, does not as a
whole count as a Modified Version of the Document, provided no compilation copyright is
claimed for the compilation. Such a compilation is called an "aggregate", and this License
does not apply to the other self-contained works thus compiled with the Document, on
account of their being thus compiled, if they are not themselves derivative works of the
Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document,
then if the Document is less than one quarter of the entire aggregate, the Document's Cover
Texts may be placed on covers that surround only the Document within the aggregate.
Otherwise they must appear on covers around the whole aggregate.
8. TRANSLATION
Translation is considered a kind of modification, so you may distribute translations of
the Document under the terms of section 4. Replacing Invariant Sections with translations
GNU Free Documentation License
77
requires special permission from their copyright holders, but you may include translations of
some or all Invariant Sections in addition to the original versions of these Invariant Sections.
You may include a translation of this License provided that you also include the original
English version of this License. In case of a disagreement between the translation and the
original English version of this License, the original English version will prevail.
9. TERMINATION
You may not copy, modify, sublicense, or distribute the Document except as expressly
provided for under this License. Any other attempt to copy, modify, sublicense or distribute
the Document is void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under this License will not
have their licenses terminated so long as such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Doc-
umentation License from time to time. Such new versions will be similar in spirit to
the present version, but may differ in detail to address new problems or concerns. See
http:/ /www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document
specifies that a particular numbered version of this License "or any later version" applies
to it, you have the option of following the terms and conditions either of that specified
version or of any later version that has been published (not as a draft) by the Free Software
Foundation. If the Document does not specify a version number of this License, you may
choose any version ever published (not as a draft) by the Free Software Foundation.
How to use this License for your documents
To use this License in a document you have written, include a copy of the License in the
document and put the following copyright and license notices just after the title page:
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
A copy of the license is included in the section entitled "GNU
Free Documentation License" .
If you have no Invariant Sections, write "with no Invariant Sections" instead of saying
which ones are invariant. If you have no Front-Cover Texts, write "no Front-Cover Texts"
instead of "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
If your document contains nontrivial examples of program code, we recommend releasing
these examples in parallel under your choice of free software license, such as the GNU
General Public License, to permit their use in free software.
Index
78
Index
A
abstract 7
admin 4
appendix 12
author 7, 8
B
block 17
body 11
c
cat 6
charset 2
content 4, 5
contents 10
copyright 7, 9
coverart 7, 9
D
dedications 10
def codeindex 6
def index 4, 6
dependencies 36
E
encoding 37
entities 37
F
f ootnotestyle 4, 5
from 6
f rontcovertext 7, 8
G
Gettext 35
H
hi 11
h2 11
h3 11
h4 11
head 3
heading 5
how to use Sgmltexi 33
I
in-line 17
indexheading 12
infodir 4, 6
installation 35
intro 11
ISOlatl 67
IS01at2 69
ISOnum 61
ISOpub 63
ISOtech 65
L
lang 2
legal 7, 9
license 7, 9
M
menu 11
menu 14
N
name 6
node 14
P
partheading 11
PATH 35
print index 12
publishnote 7, 9
s
setchapternewpage 4, 5
setf ilename 4
settitle 4, 5
shortcontents 10
spacing 2
standard entities 37
structure 2
subtitle 7
summarycontents 10
supported 38
syncodeindex 4, 6
synindex 4, 6
T
title 7
titlepage 7
to 6
tomeheading 11
tpextra 8
u
unsupported 38